Skip to main content

Voici turns Jupyter notebooks into static web applications

Project description

Voici

🚧 WARNING: Voici is still a work in progress and should not be used for production workloads. 🚧

Voici is a tool for generating static dashboards from Jupyter Notebooks. Unlike Voilà, which renders interactive dashboards using server-side execution, Voici uses WebAssembly (wasm) kernels to render notebooks in the browser, making the resulting dashboard entirely self-contained and distributable.

This is made possible thanks to the amazing work done in the JupyterLite project.

Features 🚀

  • Generates self-contained HTML files with embedded wasm kernels.
  • Works offline, without requiring a server to run the dashboard.
  • Supports custom templates for styling dashboards, powered by Jinja2.
  • Supports all programming languages that have JupyterLite kernels available. e.g. the default JavaScript and Python kernels JupyterLite provides, python with xeus-python, lua, nelson

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-0.1.0.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

voici-0.1.0-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file voici-0.1.0.tar.gz.

File metadata

  • Download URL: voici-0.1.0.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for voici-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9e60c048dfb5452726f68838d5b55676ef0510bf6a0e89a92621c096de61bac5
MD5 4d3faee1d58a55ffd31d2caa12c35fcd
BLAKE2b-256 3ad96a39c346a5d23852d8c1ea435b4181f24160a846ac636057dd11d726fcee

See more details on using hashes here.

Provenance

File details

Details for the file voici-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: voici-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for voici-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79adcacc49c71752131bfe4a2ae17e4fb4a54c47b9806707d47fe8a34a1c31ac
MD5 500130ef1c4e37bd1df11934a6134911
BLAKE2b-256 46836e191ab7f168b0c5c954f02fa139f70fd06209c1f6f5c8f601c8dc16b512

See more details on using hashes here.

Provenance

Supported by

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