# Firenze
Firenze is a lean jupyter notebook executor, that generates the notebook output in a single HTML
file.
[](https://github.com/pabloalcain/firenze/actions/workflows/ci.yaml)
[](https://codecov.io/gh/pabloalcain/firenze)
[](https://github.com/pabloalcain/firenze/blob/main/LICENSE.md)
[](https://pypi.org/project/firenze/)
[](https://github.com/ambv/black)
[](https://pypi.org/project/firenze/)
[](https://pypi.org/project/firenze/)
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`
```bash
pip install firenze
```
Suppose you have a very simple notebook that runs a "Hello, World!"
You can execute it right away with `firenze` through
```bash
firenze docs/notebooks/hello_world.ipynb
```
and the output html will be, as expected:
You can also send parameters and `firenze` will automatically modify the variable:
```bash
firenze docs/notebooks/hello_world.ipynb name=Firenze
```
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/pabloalcain/firenze",
"name": "firenze",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "jupyter,notebook",
"author": "Pablo Alcain",
"author_email": "pabloalcain@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/ec/9120ea0bbae57d9d54f2e66b0fc5549904de430dd6be287d343869d1495c/firenze-0.1.4.tar.gz",
"platform": null,
"description": "# Firenze\n\nFirenze is a lean jupyter notebook executor, that generates the notebook output in a single HTML\nfile.\n\n[](https://github.com/pabloalcain/firenze/actions/workflows/ci.yaml)\n[](https://codecov.io/gh/pabloalcain/firenze)\n[](https://github.com/pabloalcain/firenze/blob/main/LICENSE.md)\n[](https://pypi.org/project/firenze/)\n[](https://github.com/ambv/black)\n[](https://pypi.org/project/firenze/)\n[](https://pypi.org/project/firenze/)\n\nYou can also parameterize the notebooks without any modification to the notebook itself.\nIt supports local files and `s3` paths, both for the notebook and for the output.\n\n## As a Library\nYou can use `firenze` as a library in your own project. Install it through `pip`\n\n```bash\npip install firenze\n```\n\nSuppose you have a very simple notebook that runs a \"Hello, World!\"\n\n\n\nYou can execute it right away with `firenze` through\n```bash\nfirenze docs/notebooks/hello_world.ipynb\n```\nand the output html will be, as expected:\n\n\n\nYou can also send parameters and `firenze` will automatically modify the variable:\n\n```bash\nfirenze docs/notebooks/hello_world.ipynb name=Firenze\n```\n\n\n\n## As a Docker Image\nThis is still in the making, but one idea is to call `firenze` as a docker image with a notebook\nand a `requirements.txt`, so the notebook execution can be easily deployed to remote servers.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A lean executor for jupyter notebooks.",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/pabloalcain/firenze",
"Repository": "https://github.com/pabloalcain/firenze"
},
"split_keywords": [
"jupyter",
"notebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "faee20b1f7b6dcf8fb390a0b07fe4a3809983fa399e1ebab42a6b918436f7d6c",
"md5": "7dff65d49a94e85045c8b6dd8df3de3f",
"sha256": "733a79f4d5a211a7bec7473e53197fb98b2e46641ff1e980b5f1f9d2d950fd03"
},
"downloads": -1,
"filename": "firenze-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7dff65d49a94e85045c8b6dd8df3de3f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 6541,
"upload_time": "2023-11-06T15:39:05",
"upload_time_iso_8601": "2023-11-06T15:39:05.152019Z",
"url": "https://files.pythonhosted.org/packages/fa/ee/20b1f7b6dcf8fb390a0b07fe4a3809983fa399e1ebab42a6b918436f7d6c/firenze-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31ec9120ea0bbae57d9d54f2e66b0fc5549904de430dd6be287d343869d1495c",
"md5": "dbad640f7830c336ad945c0a1eda3535",
"sha256": "a23d44ee0b67d549a7fdeddc7ba4a696e4268e97dbf3a10a70478588c513a185"
},
"downloads": -1,
"filename": "firenze-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "dbad640f7830c336ad945c0a1eda3535",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 5277,
"upload_time": "2023-11-06T15:39:06",
"upload_time_iso_8601": "2023-11-06T15:39:06.653376Z",
"url": "https://files.pythonhosted.org/packages/31/ec/9120ea0bbae57d9d54f2e66b0fc5549904de430dd6be287d343869d1495c/firenze-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-06 15:39:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pabloalcain",
"github_project": "firenze",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "firenze"
}
JSON
