Skip to content

Commit bfafb05

Browse files
Update README (#562)
1 parent 0499acf commit bfafb05

File tree

1 file changed

+67
-4
lines changed

1 file changed

+67
-4
lines changed

README.md

Lines changed: 67 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Build Status](https://github.com/jupyter-server/jupyverse/workflows/test/badge.svg)](https://github.com/jupyter-server/jupyverse/actions)
22

3-
# jupyverse
3+
# Jupyverse
44

55
A set of [FPS](https://github.com/jupyter-server/fps) modules implementing a Jupyter server.
66

@@ -10,7 +10,70 @@ Try it online:
1010

1111
Documentation is available [here](https://jupyter-server.github.io/jupyverse).
1212

13-
## Motivation
13+
## Install
1414

15-
For the motivations behind this project, please refer to this issue in the
16-
[Jupyter server team compass](https://github.com/jupyter-server/team-compass/issues/11).
15+
### From PyPI
16+
17+
Jupyverse can be installed with `pip`, for instance the following:
18+
19+
```bash
20+
pip install "jupyverse[jupyterlab,auth]"
21+
```
22+
23+
will install jupyverse with the JupyterLab frontend and the [auth](https://github.com/jupyter-server/jupyverse/tree/main/plugins/auth) plugin.
24+
25+
### From conda-forge
26+
27+
Jupyverse can be installed with `micromamba`:
28+
29+
```bash
30+
micromamba create -n jupyverse
31+
micromamba activate jupyverse
32+
micromamba install jupyverse fps-jupyterlab fps-auth
33+
```
34+
35+
### Development install
36+
37+
Clone or fork this repository:
38+
39+
```bash
40+
git clone https://github.com/jupyter-server/jupyverse.git
41+
cd jupyverse
42+
```
43+
44+
Use `uv` to install all plugins:
45+
46+
```bash
47+
uv venv
48+
uv pip install --group test -e ".[ \
49+
jupyterlab, \
50+
notebook, \
51+
auth, \
52+
auth-fief, \
53+
auth-jupyterhub, \
54+
noauth, \
55+
file-watcher-poll, \
56+
kernel-web-worker, \
57+
resource-usage, \
58+
webdav \
59+
]"
60+
```
61+
62+
Run tests with:
63+
64+
```bash
65+
uv run pytest -v
66+
```
67+
68+
For testing, all the plugins are installed in the same environment. Jupyverse will automatically start all plugins
69+
registered in the `jupyverse.modules` entry point. Some of them should be disabled, for instance there should be only
70+
one authentication plugin:
71+
72+
```bash
73+
uv run jupyverse \
74+
--disable auth_fief \
75+
--disable auth_jupyterhub \
76+
--disable noauth \
77+
--disable file_watcher_poll \
78+
--disable notebook
79+
```

0 commit comments

Comments
 (0)