Skip to main content

Animated Chart Presentation in Jupyter Notebook.

Project description

ipyvizzu-story

ipyvizzu-story Animated Chart Presentation in Jupyter Notebook

Documentation · Examples · Reference · Repository

PyPI version Conda Version CI-CD

ipyvizzu-story

About The Extension

ipyvizzu-story is an extension of ipyvizzu that enables users to create interactive presentations within the data science notebook of their choice. 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. Since ipyvizzu-story's synthax is a bit different to ipyvizzu's, we suggest you to start from the ipyvizzu repo if you're interested in building animated charts but not necessarly presenting them live or to share your presentation as an HTML file.

Installation

pip install ipyvizzu-story

Visit Installation chapter of our documentation site for more details about installation.

Usage

You can check the code behind the animation on the top of the page in HTML or download it as an ipynb file.

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

ipyvizzu

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()

Visit our Documentation site for more details and a step-by-step tutorial into ipyvizzu-story or check out our Example gallery.

Environment support

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

Contributing

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

Contact

License

Copyright © 2022 Vizzu Kft..

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.5.0.tar.gz (12.0 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.5.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipyvizzu-story-0.5.0.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for ipyvizzu-story-0.5.0.tar.gz
Algorithm Hash digest
SHA256 794fdc952e528aa2acb3ea0031c4ea9425638330117456bf124af9c1004f0f04
MD5 ff4628f607626d2718397904441c0dc1
BLAKE2b-256 14f20ad75ddc50e6ddab6e333bacf4f762f6cf5bf65fba0094efe7c58afe5b1d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvizzu_story-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for ipyvizzu_story-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc15f2593349c816970a1bf877cfa2d1f832857f0c0fb30b1220bd59d24d4477
MD5 73c5123ee420d1d433e99854d39a503f
BLAKE2b-256 1c2851b3b6b9b8af5569c6dffd96ebfbb6a2ea094ba8615c408337f1d0a10939

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