-
-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve documentation: Instructions for development and test setups (#…
…130) * improve readme * use cd, because not going back up * separate the contribution instructions from the readme and keep it virtual environment tool neutral
- Loading branch information
1 parent
e5ee26d
commit a82794a
Showing
2 changed files
with
23 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Development Install | ||
|
||
``` shell | ||
git clone https://github.com/jupyterlab/jupyterlab_server.git | ||
cd jupyterlab_server | ||
pip install -e . | ||
``` | ||
|
||
# Testing | ||
|
||
It is probably best to create a virtual environment to create a local test setup. There are multiple tools for creating a Python virtual environment out there from which you can choose the one you like best. | ||
|
||
To create a local test setup run the following commands (inside your virtual environment, if you chose to create one): | ||
|
||
``` shell | ||
git clone https://github.com/jupyterlab/jupyterlab_server.git | ||
cd jupyterlab_server | ||
pip install -e .[test] # install test dependencies | ||
pytest | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters