Skip to main content

A lean executor for jupyter notebooks.

Project description

Firenze

Firenze is a lean jupyter notebook executor, that generates the notebook output in a single HTML file.

CI Coverage License Python Code style: black PyPI Downloads

You can also parameterize the notebooks without any modification to the notebook itself. It supports local files and s3 paths, both for the notebook and for the output.

As a Library

You can use firenze as a library in your own project. Install it through pip

pip install firenze

Suppose you have a very simple notebook that runs a "Hello, World!"

A notebook in jupyter

You can execute it right away with firenze through

firenze docs/notebooks/hello_world.ipynb

and the output html will be, as expected:

Hello, World! output

You can also send parameters and firenze will automatically modify the variable:

firenze docs/notebooks/hello_world.ipynb name=Firenze

Hello, Firenze! output

As a Docker Image

This is still in the making, but one idea is to call firenze as a docker image with a notebook and a requirements.txt, so the notebook execution can be easily deployed to remote servers.

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

firenze-0.1.4.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

firenze-0.1.4-py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 3

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