<p align="center">
<a href="https://ipyvizzu-story.vizzuhq.com/0.10/">
<img src="https://ipyvizzu-story.vizzuhq.com/0.10/assets/ipyvizzu-story.gif" alt="ipyvizzu-story" />
</a>
<p align="center"><b>ipyvizzu-story</b> - Build, present and share animated data stories in Jupyter Notebook and similar environments</p>
<p align="center">
<a href="https://ipyvizzu-story.vizzuhq.com/0.10/">Documentation</a>
· <a href="https://ipyvizzu-story.vizzuhq.com/0.10/examples/">Examples</a>
· <a href="https://ipyvizzu-story.vizzuhq.com/0.10/reference/ipyvizzustory/">Code reference</a>
· <a href="https://github.com/vizzuhq/ipyvizzu-story">Repository</a>
· <a href="https://blog.vizzuhq.com">Blog</a>
</p>
</p>
[](https://badge.fury.io/py/ipyvizzu-story)
[](https://anaconda.org/conda-forge/ipyvizzu-story)
[](https://github.com/vizzuhq/ipyvizzu-story/actions/workflows/cicd.yml)
# ipyvizzu-story
## About The Extension
`ipyvizzu-story` is an extension of the animated charting tool
[ipyvizzu](https://github.com/vizzuhq/ipyvizzu) that enables users to create and
present interactive data presentations within the data science notebook of their
choice and to share them as an `HTML` file. The extension provides a widget that
contains the presentation and adds controls for navigating between slides -
predefined stages within the story being presented. Navigation also works with
keyboard shortcuts - arrow keys, `PgUp`, `PgDn`, `Home`, `End` - and you can
also use a clicker to switch between the slides.
## Installation
```sh
pip install ipyvizzu-story
```
Visit
[Installation chapter](https://ipyvizzu-story.vizzuhq.com/0.10/installation)
for more options and details.
## Usage
You can check and download the code behind the animation on the top of the page
in our
[Example gallery](https://ipyvizzu-story.vizzuhq.com/0.10/examples/usbudget/).
You can create the story below with the following code snippet.
<p align="center">
<img src="https://ipyvizzu-story.vizzuhq.com/0.10/assets/readme-example.gif" alt="ipyvizzu-story" />
</p>
```python
from ipyvizzu import Data, Config
from ipyvizzustory import Story, Slide, Step
data = Data()
data.add_series("Foo", ["Alice", "Bob", "Ted"])
data.add_series("Bar", [15, 32, 12])
data.add_series("Baz", [5, 3, 2])
story = Story(data=data)
slide1 = Slide(
Step(
Config({"x": "Foo", "y": "Bar"}),
)
)
story.add_slide(slide1)
slide2 = Slide(
Step(
Config({"color": "Foo", "x": "Baz", "geometry": "circle"}),
)
)
story.add_slide(slide2)
story.play()
```
## Documentation
Visit our [Documentation site](https://ipyvizzu-story.vizzuhq.com/0.10/) for
more details and a step-by-step tutorial into `ipyvizzu-story` or check out our
[Example gallery](https://ipyvizzu-story.vizzuhq.com/0.10/examples/).
## Environments
`ipyvizzu-story` can be used in a wide variety of environments, visit
[Environments chapter](https://ipyvizzu-story.vizzuhq.com/0.10/environments/)
for more details.
- Notebooks
- [Jupyter Notebook](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/jupyternotebook/)
- [Colab](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/colab/)
- [Databricks](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/databricks/)
- [DataCamp](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/datacamp/)
- [Deepnote](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/deepnote/)
- [JupyterLab](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/jupyterlab/)
- [JupyterLite](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/jupyterlite/)
- [Kaggle](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/kaggle/)
- [Noteable](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/noteable/)
- App platforms
- [Streamlit](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/streamlit/)
- [Flask](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/flask/)
- [Panel](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/panel/)
- [Mercury](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/mercury/)
- [Voilà](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/voila/)
- BI tools
- [Mode](https://ipyvizzu-story.vizzuhq.com/0.10/environments/bi/mode/)
- IDEs
- [PyCharm](https://ipyvizzu-story.vizzuhq.com/0.10/environments/ide/pycharm/)
- [VSCode Python](https://ipyvizzu-story.vizzuhq.com/0.10/environments/ide/vscode/)
- [Python](https://ipyvizzu-story.vizzuhq.com/0.10/environments/python/)
## Contributing
We welcome contributions to the project, visit our
[Contributing guide](https://ipyvizzu-story.vizzuhq.com/0.10/CONTRIBUTING) for
further info.
## Contact
- Join our Slack if you have any questions or comments:
[vizzu-community.slack.com](https://join.slack.com/t/vizzu-community/shared_invite/zt-w2nqhq44-2CCWL4o7qn2Ns1EFSf9kEg)
- Drop us a line at hello@vizzuhq.com
- Follow us on Twitter: [VizzuHQ](https://twitter.com/VizzuHQ)
## Usage Statistics
`ipyvizzu-story` collects aggregate usage statistics by default to follow the
progress and overall trends of our library. This feature is optional, and users
can choose to opt-out. However, we do not track, collect, or store any personal
data or personally identifiable information. Please note that even when this
feature is enabled, publishing anything made with `ipyvizzu-story` remains GDPR
compatible. For more details, please visit
[Analytics chapter](https://ipyvizzu-story.vizzuhq.com/0.10/tutorial/initialization/#analytics).
## License
Copyright © 2022-2023 [Vizzu Inc](https://vizzuhq.com).
Released under the
[Apache 2.0 License](https://ipyvizzu-story.vizzuhq.com/0.10/LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "ipyvizzu-story",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python template notebook interactive presentation data-visualization charting datastory datastorytelling",
"author": "",
"author_email": "Vizzu Inc. <hello@vizzuhq.com>",
"download_url": "https://files.pythonhosted.org/packages/91/3d/4fa7141b0cdc407bc60d96096a9f298cb5dbe6a260fe9a4178490fe8e2fd/ipyvizzu_story-0.10.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://ipyvizzu-story.vizzuhq.com/0.10/\">\n <img src=\"https://ipyvizzu-story.vizzuhq.com/0.10/assets/ipyvizzu-story.gif\" alt=\"ipyvizzu-story\" />\n </a>\n <p align=\"center\"><b>ipyvizzu-story</b> - Build, present and share animated data stories in Jupyter Notebook and similar environments</p>\n <p align=\"center\">\n <a href=\"https://ipyvizzu-story.vizzuhq.com/0.10/\">Documentation</a>\n \u00b7 <a href=\"https://ipyvizzu-story.vizzuhq.com/0.10/examples/\">Examples</a>\n \u00b7 <a href=\"https://ipyvizzu-story.vizzuhq.com/0.10/reference/ipyvizzustory/\">Code reference</a>\n \u00b7 <a href=\"https://github.com/vizzuhq/ipyvizzu-story\">Repository</a>\n \u00b7 <a href=\"https://blog.vizzuhq.com\">Blog</a>\n </p>\n</p>\n\n[](https://badge.fury.io/py/ipyvizzu-story)\n[](https://anaconda.org/conda-forge/ipyvizzu-story)\n[](https://github.com/vizzuhq/ipyvizzu-story/actions/workflows/cicd.yml)\n\n# ipyvizzu-story\n\n## About The Extension\n\n`ipyvizzu-story` is an extension of the animated charting tool\n[ipyvizzu](https://github.com/vizzuhq/ipyvizzu) that enables users to create and\npresent interactive data presentations within the data science notebook of their\nchoice and to share them as an `HTML` file. The extension provides a widget that\ncontains the presentation and adds controls for navigating between slides -\npredefined stages within the story being presented. Navigation also works with\nkeyboard shortcuts - arrow keys, `PgUp`, `PgDn`, `Home`, `End` - and you can\nalso use a clicker to switch between the slides.\n\n## Installation\n\n```sh\npip install ipyvizzu-story\n```\n\nVisit\n[Installation chapter](https://ipyvizzu-story.vizzuhq.com/0.10/installation)\nfor more options and details.\n\n## Usage\n\nYou can check and download the code behind the animation on the top of the page\nin our\n[Example gallery](https://ipyvizzu-story.vizzuhq.com/0.10/examples/usbudget/).\n\nYou can create the story below with the following code snippet.\n\n<p align=\"center\">\n <img src=\"https://ipyvizzu-story.vizzuhq.com/0.10/assets/readme-example.gif\" alt=\"ipyvizzu-story\" />\n</p>\n\n```python\nfrom ipyvizzu import Data, Config\nfrom ipyvizzustory import Story, Slide, Step\n\ndata = Data()\ndata.add_series(\"Foo\", [\"Alice\", \"Bob\", \"Ted\"])\ndata.add_series(\"Bar\", [15, 32, 12])\ndata.add_series(\"Baz\", [5, 3, 2])\n\nstory = Story(data=data)\n\nslide1 = Slide(\n Step(\n Config({\"x\": \"Foo\", \"y\": \"Bar\"}),\n )\n)\nstory.add_slide(slide1)\n\nslide2 = Slide(\n Step(\n Config({\"color\": \"Foo\", \"x\": \"Baz\", \"geometry\": \"circle\"}),\n )\n)\nstory.add_slide(slide2)\n\nstory.play()\n```\n\n## Documentation\n\nVisit our [Documentation site](https://ipyvizzu-story.vizzuhq.com/0.10/) for\nmore details and a step-by-step tutorial into `ipyvizzu-story` or check out our\n[Example gallery](https://ipyvizzu-story.vizzuhq.com/0.10/examples/).\n\n## Environments\n\n`ipyvizzu-story` can be used in a wide variety of environments, visit\n[Environments chapter](https://ipyvizzu-story.vizzuhq.com/0.10/environments/)\nfor more details.\n\n- Notebooks\n - [Jupyter Notebook](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/jupyternotebook/)\n - [Colab](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/colab/)\n - [Databricks](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/databricks/)\n - [DataCamp](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/datacamp/)\n - [Deepnote](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/deepnote/)\n - [JupyterLab](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/jupyterlab/)\n - [JupyterLite](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/jupyterlite/)\n - [Kaggle](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/kaggle/)\n - [Noteable](https://ipyvizzu-story.vizzuhq.com/0.10/environments/notebook/noteable/)\n- App platforms\n - [Streamlit](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/streamlit/)\n - [Flask](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/flask/)\n - [Panel](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/panel/)\n - [Mercury](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/mercury/)\n - [Voil\u00e0](https://ipyvizzu-story.vizzuhq.com/0.10/environments/platform/voila/)\n- BI tools\n - [Mode](https://ipyvizzu-story.vizzuhq.com/0.10/environments/bi/mode/)\n- IDEs\n - [PyCharm](https://ipyvizzu-story.vizzuhq.com/0.10/environments/ide/pycharm/)\n - [VSCode Python](https://ipyvizzu-story.vizzuhq.com/0.10/environments/ide/vscode/)\n- [Python](https://ipyvizzu-story.vizzuhq.com/0.10/environments/python/)\n\n## Contributing\n\nWe welcome contributions to the project, visit our\n[Contributing guide](https://ipyvizzu-story.vizzuhq.com/0.10/CONTRIBUTING) for\nfurther info.\n\n## Contact\n\n- Join our Slack if you have any questions or comments:\n [vizzu-community.slack.com](https://join.slack.com/t/vizzu-community/shared_invite/zt-w2nqhq44-2CCWL4o7qn2Ns1EFSf9kEg)\n- Drop us a line at hello@vizzuhq.com\n- Follow us on Twitter: [VizzuHQ](https://twitter.com/VizzuHQ)\n\n## Usage Statistics\n\n`ipyvizzu-story` collects aggregate usage statistics by default to follow the\nprogress and overall trends of our library. This feature is optional, and users\ncan choose to opt-out. However, we do not track, collect, or store any personal\ndata or personally identifiable information. Please note that even when this\nfeature is enabled, publishing anything made with `ipyvizzu-story` remains GDPR\ncompatible. For more details, please visit\n[Analytics chapter](https://ipyvizzu-story.vizzuhq.com/0.10/tutorial/initialization/#analytics).\n\n## License\n\nCopyright \u00a9 2022-2023 [Vizzu Inc](https://vizzuhq.com).\n\nReleased under the\n[Apache 2.0 License](https://ipyvizzu-story.vizzuhq.com/0.10/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Build, present and share animated data stories in Jupyter Notebook and similar environments.",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://ipyvizzu-story.vizzuhq.com",
"Homepage": "https://ipyvizzu-story.vizzuhq.com",
"Source": "https://github.com/vizzuhq/ipyvizzu-story",
"Tracker": "https://github.com/vizzuhq/ipyvizzu-story/issues"
},
"split_keywords": [
"python",
"template",
"notebook",
"interactive",
"presentation",
"data-visualization",
"charting",
"datastory",
"datastorytelling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa23d088e0e18e235b85e4e25864db73035d307034c83dcccee25abeb00397b3",
"md5": "8a550a0ba3d454d416f852327ed1d6a8",
"sha256": "73f6b91a98554bd11bedc74b5e79a9cfd610b1f94b8955aa2f57c98a743cedeb"
},
"downloads": -1,
"filename": "ipyvizzu_story-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a550a0ba3d454d416f852327ed1d6a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19311,
"upload_time": "2023-12-21T18:20:04",
"upload_time_iso_8601": "2023-12-21T18:20:04.059805Z",
"url": "https://files.pythonhosted.org/packages/aa/23/d088e0e18e235b85e4e25864db73035d307034c83dcccee25abeb00397b3/ipyvizzu_story-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "913d4fa7141b0cdc407bc60d96096a9f298cb5dbe6a260fe9a4178490fe8e2fd",
"md5": "9699fe4529e72abac743e1e3ab0551cb",
"sha256": "d39de5b91a4abf3f7eed28312cdd3be299ce380f4dcc7def781de39ce348486b"
},
"downloads": -1,
"filename": "ipyvizzu_story-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "9699fe4529e72abac743e1e3ab0551cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 23390,
"upload_time": "2023-12-21T18:20:06",
"upload_time_iso_8601": "2023-12-21T18:20:06.717534Z",
"url": "https://files.pythonhosted.org/packages/91/3d/4fa7141b0cdc407bc60d96096a9f298cb5dbe6a260fe9a4178490fe8e2fd/ipyvizzu_story-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-21 18:20:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vizzuhq",
"github_project": "ipyvizzu-story",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipyvizzu-story"
}
JSON
