kedro-viz


Namekedro-viz JSON
Version 3.13.1 PyPI version JSON
download
home_pagehttps://github.com/quantumblacklabs/kedro-viz
SummaryKedro-Viz helps visualise Kedro data and analytics pipelines
upload_time2021-07-14 13:38:33
maintainer
docs_urlNone
authorQuantumBlack Labs
requires_python>=3.6, <3.9
licenseApache Software License (Apache 2.0)
keywords pipelines machine learning data pipelines data science data engineering visualisation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Kedro-Viz

[![CircleCI](https://circleci.com/gh/quantumblacklabs/kedro-viz/tree/main.svg?style=shield)](https://circleci.com/gh/quantumblacklabs/kedro-viz/tree/main)
[![npm version](https://img.shields.io/npm/v/@quantumblack/kedro-viz.svg?color=cc3534)](https://badge.fury.io/js/%40quantumblack%2Fkedro-viz)
[![Python Version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-orange.svg)](https://pypi.org/project/kedro-viz/)
[![PyPI version](https://img.shields.io/pypi/v/kedro-viz.svg?color=yellow)](https://pypi.org/project/kedro-viz/)
[![License](https://img.shields.io/badge/license-Apache%202.0-3da639.svg)](https://opensource.org/licenses/Apache-2.0)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4355948.svg)](https://doi.org/10.5281/zenodo.4355948)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Kedro-Viz shows you how your [Kedro](https://github.com/quantumblacklabs/kedro) data pipelines are structured.

With Kedro-Viz you can:

- See how your datasets and Python functions (nodes) are resolved in [Kedro](https://github.com/quantumblacklabs/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](https://github.com/quantumblacklabs/kedro-viz/blob/main/.github/img/pipeline_visualisation.png?raw=true)

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), for which more complete documentation is available on the [project website](https://facebook.github.io/create-react-app/).

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

> For in-depth development and usage notes, see the [Contribution Guidelines](https://github.com/quantumblacklabs/kedro-viz/blob/main/CONTRIBUTING.md).

> 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:

```bash
pip install kedro-viz
```

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

![Kedro CLI command](https://github.com/quantumblacklabs/kedro-viz/blob/main/.github/img/kedro_cli_example.png?raw=true)

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

```bash
kedro install
```

This will install the dependencies specified in `requirements.txt` in your Kedro environment (see [the Kedro documentation](https://kedro.readthedocs.io/en/latest/02_getting_started/01_prerequisites.html#python-virtual-environments) for how to set up your Python virtual environment).

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

```bash
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](https://kedro.readthedocs.io/en/latest/04_user_guide/06_pipelines.html#modular-pipelines) 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](https://www.npmjs.com/package/@quantumblack/kedro-viz). To install it:

```bash
npm install @quantumblack/kedro-viz
```

Then include it in your React application:

```javascript
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](https://github.com/quantumblacklabs/kedro-viz/blob/main/src/components/app/index.js). For examples of the expected data input format, see the mock data examples in [/src/utils/data](https://github.com/quantumblacklabs/kedro-viz/tree/main/src/utils/data), and compare the [resulting demo](https://quantumblacklabs.github.io/kedro-viz/).

## Flags

The following flags are available to toggle experimental features:

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

### 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&newparams=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](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#The_JavaScript_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](https://github.com/quantumblacklabs/kedro-viz/blob/main/LICENSE.md) 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](https://doi.org/10.5281/zenodo.4277218).

<p align="center">↑↑↓↓←→←→BA</p>



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/quantumblacklabs/kedro-viz",
    "name": "kedro-viz",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6, <3.9",
    "maintainer_email": "",
    "keywords": "pipelines,machine learning,data pipelines,data science,data engineering,visualisation",
    "author": "QuantumBlack Labs",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/73/ae/1485d5bb5d8342028a754269da55248b63f2358b00b4eeef2574b77c1b90/kedro-viz-3.13.1.tar.gz",
    "platform": "",
    "description": "# Kedro-Viz\n\n[![CircleCI](https://circleci.com/gh/quantumblacklabs/kedro-viz/tree/main.svg?style=shield)](https://circleci.com/gh/quantumblacklabs/kedro-viz/tree/main)\n[![npm version](https://img.shields.io/npm/v/@quantumblack/kedro-viz.svg?color=cc3534)](https://badge.fury.io/js/%40quantumblack%2Fkedro-viz)\n[![Python Version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-orange.svg)](https://pypi.org/project/kedro-viz/)\n[![PyPI version](https://img.shields.io/pypi/v/kedro-viz.svg?color=yellow)](https://pypi.org/project/kedro-viz/)\n[![License](https://img.shields.io/badge/license-Apache%202.0-3da639.svg)](https://opensource.org/licenses/Apache-2.0)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4355948.svg)](https://doi.org/10.5281/zenodo.4355948)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\nKedro-Viz shows you how your [Kedro](https://github.com/quantumblacklabs/kedro) data pipelines are structured.\n\nWith Kedro-Viz you can:\n\n- See how your datasets and Python functions (nodes) are resolved in [Kedro](https://github.com/quantumblacklabs/kedro) so that you can understand how your data pipeline is built\n- Get a clear picture when you have lots of datasets and nodes by using tags to visualise sub-pipelines\n- Search for nodes and datasets\n\n![Kedro-Viz Pipeline Visualisation](https://github.com/quantumblacklabs/kedro-viz/blob/main/.github/img/pipeline_visualisation.png?raw=true)\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), for which more complete documentation is available on the [project website](https://facebook.github.io/create-react-app/).\n\n## How do I install and use Kedro-Viz?\n\n> For in-depth development and usage notes, see the [Contribution Guidelines](https://github.com/quantumblacklabs/kedro-viz/blob/main/CONTRIBUTING.md).\n\n> 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.\n\n### As a Kedro Python plugin\n\nKedro-Viz is available as a Python plugin named `kedro-viz`.\n\nThe following conditions must be true in order to visualise your pipeline:\n\n- Your project directory must be available to the Kedro-Viz plugin.\n- You must be using a Kedro project structure with a complete Data Catalog, nodes and pipeline structure.\n\nTo install it:\n\n```bash\npip install kedro-viz\n```\n\nThis will install `kedro` as a dependency, and add `kedro viz` as an additional CLI command.\n\n![Kedro CLI command](https://github.com/quantumblacklabs/kedro-viz/blob/main/.github/img/kedro_cli_example.png?raw=true)\n\nTo visualise your pipeline, go to your project root directory and install the project-specific dependencies by running:\n\n```bash\nkedro install\n```\n\nThis will install the dependencies specified in `requirements.txt` in your Kedro environment (see [the Kedro documentation](https://kedro.readthedocs.io/en/latest/02_getting_started/01_prerequisites.html#python-virtual-environments) for how to set up your Python virtual environment).\n\nFinally, run the following command from the project directory to visualise your pipeline:\n\n```bash\nkedro viz\n```\n\nThis command will run kedro_viz.server on `http://127.0.0.1:4141/` which cannot be accessed from another machine.\n\nKedro-Viz has a number of options to customise running the visualisation:\n| CLI command | Description |\n| ----------- | ----------- |\n| `--host` | Host that viz will listen to. Defaults to 127.0.0.1. |\n| `--port` | TCP port that viz will listen to. Defaults to 4141. |\n| `--browser/--no-browser` | Whether to open viz interface in the default browser or not. |\n| `--load-file` | Path to load the pipeline JSON file |\n| `--save-file` | Path to save the pipeline JSON file |\n| `--pipeline` | Name of the [modular pipeline](https://kedro.readthedocs.io/en/latest/04_user_guide/06_pipelines.html#modular-pipelines) to visualise. If not set, the default pipeline is visualised. |\n| `--env`, `-e` | Kedro configuration environment. If not specified, catalog config in `local` will be used. |\n\n\n### As a JavaScript React component\n\nKedro-Viz is also available as an npm package named [@quantumblack/kedro-viz](https://www.npmjs.com/package/@quantumblack/kedro-viz). To install it:\n\n```bash\nnpm install @quantumblack/kedro-viz\n```\n\nThen include it in your React application:\n\n```javascript\nimport KedroViz from '@quantumblack/kedro-viz';\n\nconst MyApp = () => <KedroViz data={json} />;\n```\n\nAs a JavaScript React component, the project is designed to be used in two different ways:\n\n1. **Standalone application**\n\n   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`.\n\n2. **React component**\n\n   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.\n\n   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](https://github.com/quantumblacklabs/kedro-viz/blob/main/src/components/app/index.js). For examples of the expected data input format, see the mock data examples in [/src/utils/data](https://github.com/quantumblacklabs/kedro-viz/tree/main/src/utils/data), and compare the [resulting demo](https://quantumblacklabs.github.io/kedro-viz/).\n\n## Flags\n\nThe following flags are available to toggle experimental features:\n\n- `newparams` - From release v3.12.0. Disable parameters on page load and highlight parameter connections.\n- `sizewarning` - From release v3.9.1. Show a warning before rendering very large graphs. (default `true`)\n\n### Setting flags\n\nTo 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.\n\n`http://localhost:4141/?data=demo&newparams=true`\n\nThe setting you provide persists for all sessions on your machine, until you change it.\n\n### Viewing flags\n\nKedro-Viz will log a message in your browser's [developer console](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#The_JavaScript_console) regarding the available flags and their values as currently set on your machine.\n\n## What licence do you use?\n\nKedro-Viz is licensed under the [Apache 2.0](https://github.com/quantumblacklabs/kedro-viz/blob/main/LICENSE.md) License.\n\n## How can I cite Kedro-Viz?\n\nIf 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](https://doi.org/10.5281/zenodo.4277218).\n\n<p align=\"center\">\u2191\u2191\u2193\u2193\u2190\u2192\u2190\u2192BA</p>\n\n\n",
    "bugtrack_url": null,
    "license": "Apache Software License (Apache 2.0)",
    "summary": "Kedro-Viz helps visualise Kedro data and analytics pipelines",
    "version": "3.13.1",
    "split_keywords": [
        "pipelines",
        "machine learning",
        "data pipelines",
        "data science",
        "data engineering",
        "visualisation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ca0d59053bef56d9d7769782490644cd",
                "sha256": "16526625f430f8652183582a558d3c9aafed7323da24a5266c7949a4f61b23d2"
            },
            "downloads": -1,
            "filename": "kedro_viz-3.13.1-py3.8.egg",
            "has_sig": false,
            "md5_digest": "ca0d59053bef56d9d7769782490644cd",
            "packagetype": "bdist_egg",
            "python_version": "3.13.1",
            "requires_python": ">=3.6, <3.9",
            "size": 2963584,
            "upload_time": "2021-07-14T13:38:36",
            "upload_time_iso_8601": "2021-07-14T13:38:36.121255Z",
            "url": "https://files.pythonhosted.org/packages/a2/c3/14de41c06df7aaf9c61a08fe094feaaa8b20068248330a685a768950c604/kedro_viz-3.13.1-py3.8.egg",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "9fa448203c9764fca268e6b3cece961d",
                "sha256": "439dcafa4eb549f7917c225ceb8222406c6d5164f2616522c703638709027fc5"
            },
            "downloads": -1,
            "filename": "kedro_viz-3.13.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9fa448203c9764fca268e6b3cece961d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6, <3.9",
            "size": 2932636,
            "upload_time": "2021-07-14T13:38:31",
            "upload_time_iso_8601": "2021-07-14T13:38:31.368257Z",
            "url": "https://files.pythonhosted.org/packages/41/45/e42b14b1ae3425f39bc9931322536c507c00256f55c248c56e8dc99e5230/kedro_viz-3.13.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "64f7cf8491f7ad6db3fc349f98d8ea54",
                "sha256": "a4dc04b0ee8a67ec44b8d6b7c52de2dc19e30580d5c0b7de8898c3a67230c75f"
            },
            "downloads": -1,
            "filename": "kedro-viz-3.13.1.tar.gz",
            "has_sig": false,
            "md5_digest": "64f7cf8491f7ad6db3fc349f98d8ea54",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6, <3.9",
            "size": 2891155,
            "upload_time": "2021-07-14T13:38:33",
            "upload_time_iso_8601": "2021-07-14T13:38:33.526808Z",
            "url": "https://files.pythonhosted.org/packages/73/ae/1485d5bb5d8342028a754269da55248b63f2358b00b4eeef2574b77c1b90/kedro-viz-3.13.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-07-14 13:38:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "quantumblacklabs",
    "github_project": "kedro-viz",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "kedro-viz"
}
        
Elapsed time: 0.28730s