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

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

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.7.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ipyvizzu_story-0.7.0-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file ipyvizzu-story-0.7.0.tar.gz.

File metadata

  • Download URL: ipyvizzu-story-0.7.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for ipyvizzu-story-0.7.0.tar.gz
Algorithm Hash digest
SHA256 8df2e68e9242684ee07ecb7b8fa4d759e66d5a6f964ce799ebbcb43221469e27
MD5 c0291c6f3adcf788e8cc1430ddfda9a7
BLAKE2b-256 d6badcf6d7720de20940340032188c05a3a9fb29459c5b518c8d1012c0d82283

See more details on using hashes here.

File details

Details for the file ipyvizzu_story-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: ipyvizzu_story-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for ipyvizzu_story-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f2ffd1b1ece867e278a70b3bf47a0427210aaab0a135b8cd24d7fc076c50653
MD5 1cd869082780db11a79ffbd23dc535ec
BLAKE2b-256 abe45cbbd58be28bc045b98a3d9113d915e630ce03087130555111f94b203249

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page