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

Commit 974e729

Browse files
authored
Merge pull request #45 from martinRenou/update_readme_config
Update README with config options
2 parents 58fc8fd + 4a73382 commit 974e729

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,25 @@ Then build your JupyterLite site:
2929
jupyter lite build
3030
```
3131

32-
## Uninstall
32+
## Pre-installed packages
3333

34-
To remove the extension, execute:
34+
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``.
35+
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.
36+
37+
For example, say you want to install ``NumPy``, ``Matplotlib`` and ``ipyleaflet``, it can be done with the following command:
3538

3639
```bash
37-
pip uninstall jupyterlite-xeus-python
40+
jupyter lite build --XeusPythonEnv.packages=numpy,matplotlib,ipyleaflet
41+
```
42+
43+
The same can be achieved through a ``jupyterlite_config.json`` file:
44+
45+
```json
46+
{
47+
"XeusPythonEnv": {
48+
"packages": ["numpy", "matplotlib", "ipyleaflet"]
49+
}
50+
}
3851
```
3952

4053
## Contributing

0 commit comments

Comments
 (0)