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.6.0.tar.gz (16.4 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.6.0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipyvizzu-story-0.6.0.tar.gz
  • Upload date:
  • Size: 16.4 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.6.0.tar.gz
Algorithm Hash digest
SHA256 fad226be284786b70b2426a954d8ff015887eba50ec9aa93eb24e5931806cdab
MD5 7d2d962e76e7e7d97cce4411ae2c0c26
BLAKE2b-256 0a382de56c847c5a5d04882db5180ceab06d108f5eeb48cc8ce539af68354034

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvizzu_story-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 16.9 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 264fa93a93d8442617e631044078b87c49eef87b99bdae054d40a37110fa1009
MD5 37c48a51e94d8f44276fb5c695752432
BLAKE2b-256 e06abfb443233117a21aea928c11c1f0c47d8b58bb57c0cb14a72fbb5c5fc5b3

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