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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file firenze-0.1.4.tar.gz.

File metadata

  • Download URL: firenze-0.1.4.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.2 Linux/6.1.0-13-amd64

File hashes

Hashes for firenze-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a23d44ee0b67d549a7fdeddc7ba4a696e4268e97dbf3a10a70478588c513a185
MD5 dbad640f7830c336ad945c0a1eda3535
BLAKE2b-256 31ec9120ea0bbae57d9d54f2e66b0fc5549904de430dd6be287d343869d1495c

See more details on using hashes here.

File details

Details for the file firenze-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: firenze-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.2 Linux/6.1.0-13-amd64

File hashes

Hashes for firenze-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 733a79f4d5a211a7bec7473e53197fb98b2e46641ff1e980b5f1f9d2d950fd03
MD5 7dff65d49a94e85045c8b6dd8df3de3f
BLAKE2b-256 faee20b1f7b6dcf8fb390a0b07fe4a3809983fa399e1ebab42a6b918436f7d6c

See more details on using hashes here.

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