Skip to main content

Build, present and share animated data stories in Jupyter Notebook and similar environments.

Project description

ipyvizzu-story

ipyvizzu-story - Build, present and share animated data stories in Jupyter Notebook and similar environments

Documentation · Examples · Code reference · Repository · Blog

PyPI version Conda Version CI-CD

ipyvizzu-story

About The Extension

ipyvizzu-story is an extension of the animated charting tool 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

pip install ipyvizzu-story

Visit Installation chapter 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.

You can create the story below with the following code snippet.

ipyvizzu-story

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 for more details and a step-by-step tutorial into ipyvizzu-story or check out our Example gallery.

Environments

ipyvizzu-story can be used in a wide variety of environments, visit Environments chapter for more details.

Contributing

We welcome contributions to the project, visit our Contributing guide for further info.

Contact

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.

License

Copyright © 2022-2023 Vizzu Inc.

Released under the Apache 2.0 License.

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

ipyvizzu_story-0.10.0.tar.gz (23.4 kB view hashes)

Uploaded source

Built Distribution

ipyvizzu_story-0.10.0-py3-none-any.whl (19.3 kB view hashes)

Uploaded py3

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