Skip to main content

Creates a static visualization of your pipeline

Project description

Kedro-Static-Viz

Kedro-Static-Viz creates a static website for your Kedro data pipelines. Kedro static viz is a very small python cli that makes your kedro-viz generated pipeline.json data available to a static appication built with gatsbyjs. The benefit of this is that it it can be built inside of a ci service such as github actions and deployed to a number to static file hosts such as Netlify, Now.sh, github pages, S3. Free options are endless these days. By default the site will be built to the public directory.

Python package

PyPI version


Example Site

Build public.tar.gz and Deploy example to gh-pages

On every push to master in this repo kedro-static-viz.waylonwalker.com is built and deployed.

How do I install and use Kedro-Static-Viz?

As a Kedro Python plugin

Kedro-Static-Viz is available as a Python plugin named kedro-static-viz.

The following conditions must be true in order to visualise your pipeline:

  • Your project directory must be available to the Kedro-Static-Viz plugin.
  • You must be using a Kedro data pipelines project structure with a complete Data Catalog, nodes and pipeline structure.

To install it:

pip install kedro-static-viz

This will install kedro as a dependency, and add kedro static-viz as an additional CLI command.

To visualise your pipeline, go to your project root directory and install the project-specific dependencies by running:

kedro install

This will install the dependencies specified in requirements.txt in your Kedro environment (see the Kedro documentation for how to set up your Python virtual environment).

Finally, run the following command from the project directory to visualise your pipeline:

kedro static-viz

This command will run kedro_viz.server on http://127.0.0.1:4141/ which cannot be accessed from another machine.

Kedro-Viz has a number of options to customise running the visualisation: | CLI command | Description | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --port | TCP port that viz will listen to. Defaults to 4141. | | --browser/--no-browser | Whether to open viz interface in the default browser or not. | | --load-file | Path to load the pipeline JSON file | | --pipeline | Name of the modular pipeline to visualise. If not set, the default pipeline is visualised. | | --env, -e | Kedro configuration environment. If not specified, catalog config in local will be used.
| --directory | Directory to render the static site to | | --serve/--no-serve | Whether or not to serve the site after creating. Defaults to True. |

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kedro-static-viz, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size kedro_static_viz-0.1.2-py3-none-any.whl (427.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size kedro-static-viz-0.1.2.tar.gz (429.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page