Skip to main content

Voici turns Jupyter notebooks into static web applications

Project description

voici

Github Actions Status JupyterLite Documentation Status

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

voici_core-0.10.0.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

voici_core-0.10.0-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file voici_core-0.10.0.tar.gz.

File metadata

  • Download URL: voici_core-0.10.0.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for voici_core-0.10.0.tar.gz
Algorithm Hash digest
SHA256 fc3ddc58df7eccd56982cdb5b3ea4cb18126035a49c23d67adf338ef3fcd9440
MD5 f49c6976a9cdd74fc06f8ebf2929d1f9
BLAKE2b-256 c57b683c2cc8010c6acf38554193f2cea87e9c7d77df81d77e266395b675dd25

See more details on using hashes here.

File details

Details for the file voici_core-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: voici_core-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for voici_core-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d55f8e508a283f93a7caafe636ed08c17b42669201b81a962bef871f7f5ffd34
MD5 6dc77515062b4c0dd660276f9c58571f
BLAKE2b-256 5f30fe2d046c0f71f82e5243548e3172906b7dffaa67ca2ed80f0bdaa7d396db

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page