Voici turns Jupyter notebooks into static web applications
Project description
The voici-core
package provides the core functionality for building voici dashboards using the voici CLI.
Getting Started 🏁
To use Voici, you'll need to install it first:
pip install voici-core
# OR BETTER
conda install -c conda-forge voici-core
# OR EVEN FASTER
mamba install -c conda-forge voici-core
Then, you can generate static dashboards from a notebook or a directory of Notebooks like this:
# Build a single dashboard
voici my-notebook.ipynb
# Build a directory of notebooks
voici notebooks/
Once your dashboards are built, you can simply serve them with a simple static server, e.g.:
cd _output
python -m http.server
Limitations ⚠️
Because Voici uses Wasm kernels to execute notebooks, there are some limitations to the types of notebooks that can be rendered: Some notebook features may not work correctly or may have limited functionality when rendered in Voici.
Contributing 👋
If you find a bug or have a feature request, please open an issue on the GitHub repository. If you'd like to contribute code, please fork the repository and submit a pull request. We welcome contributions from anyone!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file voici_core-0.7.1.tar.gz
.
File metadata
- Download URL: voici_core-0.7.1.tar.gz
- Upload date:
- Size: 2.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f870fc362ab08a189ed013b7ddb2b482e83873ad72efe74e82aed33acb7126ae |
|
MD5 | d5940f60e3fa6953e3e63645e1cb9903 |
|
BLAKE2b-256 | f04619e35a37ec2a7bb2879f568bba84615be121b215c1b185c202d8c5f632dc |
Provenance
File details
Details for the file voici_core-0.7.1-py3-none-any.whl
.
File metadata
- Download URL: voici_core-0.7.1-py3-none-any.whl
- Upload date:
- Size: 2.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60df630ff6721756f447d50bf1defde13800cc454325a2e4ada3c6ffa1c7bafa |
|
MD5 | e59164478f7a0fb9055187ddfe47c321 |
|
BLAKE2b-256 | 314e2efcc47d9543ad7fd388be9f78c43364fa235f073687451ff9ac89efed18 |