Skip to content
This repository was archived by the owner on Feb 14, 2024. It is now read-only.

Update README with config options #45

Merged
merged 1 commit into from
Jun 28, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,25 @@ Then build your JupyterLite site:
jupyter lite build
```

## Uninstall
## Pre-installed packages

To remove the extension, execute:
xeus-python allows you to pre-install packages in the Python runtime. You can pre-install packages by passing the ``XeusPythonEnv.packages`` CLI option to ``jupyter lite build``.
This will automatically install any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.

For example, say you want to install ``NumPy``, ``Matplotlib`` and ``ipyleaflet``, it can be done with the following command:

```bash
pip uninstall jupyterlite-xeus-python
jupyter lite build --XeusPythonEnv.packages=numpy,matplotlib,ipyleaflet
```

The same can be achieved through a ``jupyterlite_config.json`` file:

```json
{
"XeusPythonEnv": {
"packages": ["numpy", "matplotlib", "ipyleaflet"]
}
}
```

## Contributing
Expand Down