Skip to content

Commit a82794a

Browse files
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
1 parent e5ee26d commit a82794a

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Development Install
2+
3+
``` shell
4+
git clone https://github.com/jupyterlab/jupyterlab_server.git
5+
cd jupyterlab_server
6+
pip install -e .
7+
```
8+
9+
# Testing
10+
11+
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.
12+
13+
To create a local test setup run the following commands (inside your virtual environment, if you chose to create one):
14+
15+
``` shell
16+
git clone https://github.com/jupyterlab/jupyterlab_server.git
17+
cd jupyterlab_server
18+
pip install -e .[test] # install test dependencies
19+
pytest
20+
```

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,13 @@ https://github.com/jupyterlab/jupyterlab_server
1010
`pip install jupyterlab_server`
1111

1212
## Usage
13+
1314
The application author creates a JupyterLab build on their machine
1415
using the core JupyterLab application. They can then serve their
1516
files by subclassing the `LabServerApp` with the appropriate
1617
configuration and creating a Python entry point that launches the app.
1718

1819

19-
## Development Install
20+
## Contribution
2021

21-
```
22-
git clone https://github.com/jupyterlab/jupyterlab_server.git
23-
cd jupyterlab_server
24-
pip install -e .
25-
```
22+
Please see `CONTRIBUTING.md` for details.

0 commit comments

Comments
 (0)