Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: clarify voici and voici-core differences #110

Merged
merged 3 commits into from
Jan 30, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Jeremy suggestions
Co-authored-by: Jeremy Tuloup <[email protected]>
martinRenou and jtpio authored Jan 30, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit dcadef3ab8da2e7e70102239a9db0f058cf0c10c
6 changes: 3 additions & 3 deletions python/voici/README.md
Original file line number Diff line number Diff line change
@@ -23,8 +23,8 @@ https://user-images.githubusercontent.com/591645/222892327-2a5b1341-640d-49c2-9e

Voici is split between two Python packages:

- The `voici-core` package is the core functionalities of voici, mainly the voici CLI.
- The `voici` package is a meta-package installing both `voici-core` and [`jupyterlite-xeus`](https://github.com/jupyterlite/xeus).
- The `voici-core` package provides the core functionalities of voici, mainly the voici CLI.
- The `voici` package is a meta-package that depends on both `voici-core` and [`jupyterlite-xeus`](https://github.com/jupyterlite/xeus).

`jupyterlite-xeus` allows you to pre-install packages for running your dashboard. For example, if your dashboard requires Matplotlib you can provide an `environment.yml` file in the folder where you run the voici command, containing the following:

@@ -46,7 +46,7 @@ Note that you can install multiple xeus kernels like [xeus-python](https://githu
See the [jupyterlite-xeus documentation](https://jupyterlite-xeus.readthedocs.io/en/latest/) for more information
```

If you would like to use https://github.com/jupyterlite/pyodide-kernel or another non-xeus kernel, you probably want to depend on `voici-core` instead.
If you would like to use https://github.com/jupyterlite/pyodide-kernel or another non-xeus kernel, you may want to depend on `voici-core` and `jupyterlite-pyodide-kernel` instead.

## Getting Started 🏁