<!--
{% comment %}
Copyright 2017-2023 Elyra Authors
Copyright 2025 Orange Bricks
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
{% endcomment %}
-->
# Auto Dashboards
[](https://github.com/orbrx/auto-dashboards/actions/workflows/build.yml)
Convert Jupyter notebooks to dashboards in one click and preview side-by-side.
Streamlit and Solara are supported targets.
https://github.com/user-attachments/assets/aa2c25e1-c95a-470d-8879-0b4fb3c5e158
## Requirements
- JupyterLab >= 4.2
- OpenAI
- you are required to provide your OpenAI API key to be able to convert notebooks to dashboards. Export it before starting JupyterLab:
```bash
export OPENAI_API_KEY="your-api-key"
```
## Install
To install the extension, execute:
```bash
pip install auto-dashboards
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall auto-dashboards
```
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
## Acknowledgments
This extension is initially based on the Elyra AI Toolkit's [Streamlit extension](https://github.com/elyra-ai/streamlit-extension) that provides Streamlit execution and preview functionality.
This extension is inspired by the POC from a wonderful BreakThrough AI Team during the Fall 2023 session: [@anikaguin](https://github.com/anikaguin), [@mpate154](https://github.com/mpate154), [@z3yn3p-alta](https://github.com/z3yn3p-alta). Check out their [project](https://github.com/anikaguin/Axle-Informatics/tree/main).
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the auto_dashboards directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable auto_dashboards
# Rebuild extension Typescript source after making changes
jlpm build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
# Server extension must be manually disabled in develop mode
jupyter server extension disable auto_dashboards
pip uninstall auto-dashboards
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `@orbrx/auto-dashboards` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/orbrx/auto-dashboards",
"name": "auto-dashboards",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Jupyter, JupyterLab, JupyterLab4",
"author": "Orange Bricks",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/33/ff/ab79177e6268a318bceb4a12b71a08ba798fe1f19a17aa6da57d9dc46c67/auto_dashboards-0.2.0.tar.gz",
"platform": "Linux",
"description": "<!--\n{% comment %}\nCopyright 2017-2023 Elyra Authors\nCopyright 2025 Orange Bricks\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n{% endcomment %}\n-->\n\n# Auto Dashboards\n\n[](https://github.com/orbrx/auto-dashboards/actions/workflows/build.yml)\n\nConvert Jupyter notebooks to dashboards in one click and preview side-by-side.\nStreamlit and Solara are supported targets.\n\nhttps://github.com/user-attachments/assets/aa2c25e1-c95a-470d-8879-0b4fb3c5e158\n\n\n## Requirements\n\n- JupyterLab >= 4.2\n- OpenAI\n - you are required to provide your OpenAI API key to be able to convert notebooks to dashboards. Export it before starting JupyterLab:\n ```bash\n export OPENAI_API_KEY=\"your-api-key\"\n ```\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install auto-dashboards\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall auto-dashboards\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n## Acknowledgments\n\nThis extension is initially based on the Elyra AI Toolkit's [Streamlit extension](https://github.com/elyra-ai/streamlit-extension) that provides Streamlit execution and preview functionality.\n\nThis extension is inspired by the POC from a wonderful BreakThrough AI Team during the Fall 2023 session: [@anikaguin](https://github.com/anikaguin), [@mpate154](https://github.com/mpate154), [@z3yn3p-alta](https://github.com/z3yn3p-alta). Check out their [project](https://github.com/anikaguin/Axle-Informatics/tree/main).\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the auto_dashboards directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable auto_dashboards\n# Rebuild extension Typescript source after making changes\njlpm build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable auto_dashboards\npip uninstall auto-dashboards\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `@orbrx/auto-dashboards` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Auto convert Jupyter notebooks to dashboards",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/orbrx/auto-dashboards"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab4"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1ab9b8db53007062136f50d2b77fa629e704173823b837144d8ea126a9ed648f",
"md5": "f8bda79cd2ee9bdea467eed2f4909e84",
"sha256": "44047ae3efc311545bda3220cd3726828328dcc401598ec851e5b7d8bb39ec4f"
},
"downloads": -1,
"filename": "auto_dashboards-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8bda79cd2ee9bdea467eed2f4909e84",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 119485,
"upload_time": "2025-02-22T20:29:07",
"upload_time_iso_8601": "2025-02-22T20:29:07.911197Z",
"url": "https://files.pythonhosted.org/packages/1a/b9/b8db53007062136f50d2b77fa629e704173823b837144d8ea126a9ed648f/auto_dashboards-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "33ffab79177e6268a318bceb4a12b71a08ba798fe1f19a17aa6da57d9dc46c67",
"md5": "e14d67ed0f25c9d57a75dbdfe1ea6bca",
"sha256": "1705161d8c7b12024c424b409b6b2c64743c28af8593f6fe8434bb38a3666ba5"
},
"downloads": -1,
"filename": "auto_dashboards-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e14d67ed0f25c9d57a75dbdfe1ea6bca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 145725,
"upload_time": "2025-02-22T20:29:09",
"upload_time_iso_8601": "2025-02-22T20:29:09.694510Z",
"url": "https://files.pythonhosted.org/packages/33/ff/ab79177e6268a318bceb4a12b71a08ba798fe1f19a17aa6da57d9dc46c67/auto_dashboards-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-22 20:29:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "orbrx",
"github_project": "auto-dashboards",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "auto-dashboards"
}
JSON
