Skip to content

Commit

Permalink
Document the command to launch JupyterLab and watch for changes to th…
Browse files Browse the repository at this point in the history
…e backend code for server extensions
  • Loading branch information
joaopalmeiro committed Dec 19, 2024
1 parent 7f5cd10 commit 5c5eb9a
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion server-extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ done using [hatch](https://hatch.pypa.io/) builder with some additional plugins:
- [hatch-jupyter-builder](https://github.com/jupyterlab/hatch-jupyter-builder/): Builder plugin to build Jupyter JavaScript assets as part of the Python package.
Its configuration is done in `pyproject.toml`:

```
```toml
# pyproject.toml

[build-system]
Expand Down Expand Up @@ -758,6 +758,18 @@ And that server extension is available through `pip`:
For more information on the `discovery` metadata, please refer to the [documentation](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html#ext-author-companion-packages).
## Development
While developing your server extension, you can run JupyterLab and enable server reloading using the following command:
```bash
jupyter lab --autoreload --no-browser
```
This way, every time there is a change to the backend (server) code, JupyterLab is automatically relaunched, picking up the most recent changes.
The `--no-browser` flag is optional, but it helps prevent a new browser tab from opening each time JupyterLab is launched.
## Installing the Package
With the packaging described above, installing the extension is done in one command once the package is published on pypi.org:
Expand Down

0 comments on commit 5c5eb9a

Please sign in to comment.