Skip to main content

Kedro-Viz helps visualise Kedro data and analytics pipelines

Project description

Kedro-Viz

CircleCI npm version Python Version PyPI version License DOI code style: prettier

Kedro-Viz shows you how your Kedro data pipelines are structured.

With Kedro-Viz you can:

  • See how your datasets and Python functions (nodes) are resolved in Kedro so that you can understand how your data pipeline is built
  • Get a clear picture when you have lots of datasets and nodes by using tags to visualise sub-pipelines
  • Search for nodes and datasets

Kedro-Viz Pipeline Visualisation

This project was bootstrapped with Create React App, for which more complete documentation is available on the project website.

How do I install and use Kedro-Viz?

For in-depth development and usage notes, see the Contribution Guidelines.

It's likely that Kedro-Viz>=3.8.0 will not work with projects created with older versions of Kedro<=0.16.6. Please migrate your project to Kedro>=0.17.0 before installation of the latest version of Kedro-Viz.

As a Kedro Python plugin

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

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

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

To install it:

pip install kedro-viz

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

Kedro 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 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 | | ----------- | ----------- | | --host | Host that viz will listen to. Defaults to 127.0.0.1. | | --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 | | --save-file | Path to save 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. |

As a JavaScript React component

Kedro-Viz is also available as an npm package named @quantumblack/kedro-viz. To install it:

npm install @quantumblack/kedro-viz

Then include it in your React application:

import KedroViz from '@quantumblack/kedro-viz';

const MyApp = () => <KedroViz data={json} />;

As a JavaScript React component, the project is designed to be used in two different ways:

  1. Standalone application

    Run npm run build to generate a production build as a full-page app. The built app will be placed in the /build directory. Data for the chart should be placed in /public/api/main because this directory is marked gitignore.

  2. React component

    Kedro-Viz can be used as a React component that can be imported into other applications. Publishing the package will run npm run lib, which compiles the source code in /src, and places it in the /lib directory.

    The React component exposes props that can be used to supply data and customise its behaviour. For information about the props, their expected prop-types and default values, see /src/components/app/index.js. For examples of the expected data input format, see the mock data examples in /src/utils/data, and compare the resulting demo.

Flags

The following flags are available to toggle experimental features:

  • oldgraph - From release v3.8.0. Display old version of graph (dagre algorithm) without improved graphing algorithm. (default false)
  • newparams - From release v3.12.0. Disable parameters on page load and highlight parameter connections.
  • sizewarning - From release v3.9.1. Show a warning before rendering very large graphs. (default true)
  • modularpipeline - From release v3.11.0. Enables filtering of nodes by modular pipelines. Note that selecting both modular pipeline and tag filters will only return nodes that belongs to both categories. (default false).

Note that newgraph has been removed from v3.8.0 onwards and is now the default functionality. Should there be issues with your project, see the oldgraph flag above.

Setting flags

To enable or disable a flagged feature, add the flag as a parameter with the value true or false to the end of the URL in your browser when running Kedro-Viz, e.g.

http://localhost:4141/?data=demo&oldgraph=true

The setting you provide persists for all sessions on your machine, until you change it.

Viewing flags

Kedro-Viz will log a message in your browser's developer console regarding the available flags and their values as currently set on your machine.

What licence do you use?

Kedro-Viz is licensed under the Apache 2.0 License.

How can I cite Kedro-Viz?

If you're an academic, Kedro-Viz can also help you, for example, as a tool to visualise how your publication's pipeline is structured. Find our citation reference on Zenodo.

↑↑↓↓←→←→BA

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-viz, version 3.12.0
Filename, size File type Python version Upload date Hashes
Filename, size kedro_viz-3.12.0-py3.8.egg (9.3 MB) File type Egg Python version 3.12.0 Upload date Hashes View
Filename, size kedro_viz-3.12.0-py3-none-any.whl (3.0 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size kedro-viz-3.12.0.tar.gz (2.9 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page