{"id":13459579,"url":"https://github.com/WaylonWalker/kedro-static-viz","last_synced_at":"2025-03-24T18:30:48.759Z","repository":{"id":42287360,"uuid":"245470989","full_name":"WaylonWalker/kedro-static-viz","owner":"WaylonWalker","description":"kedro cli plugin for generating a static kedro viz site (html, css, js) that can be deployed on many serverless tools.","archived":false,"fork":false,"pushed_at":"2023-01-06T02:40:37.000Z","size":14282,"stargazers_count":27,"open_issues_count":30,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-07T13:49:30.695Z","etag":null,"topics":["data","dataengineering","datapipeline","kedro","kedro-plugin","python"],"latest_commit_sha":null,"homepage":"https://static-viz.kedro.dev","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WaylonWalker.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"WaylonWalker","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-03-06T16:44:40.000Z","updated_at":"2024-04-22T11:32:50.000Z","dependencies_parsed_at":"2023-02-05T03:31:43.288Z","dependency_job_id":null,"html_url":"https://github.com/WaylonWalker/kedro-static-viz","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WaylonWalker%2Fkedro-static-viz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WaylonWalker%2Fkedro-static-viz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WaylonWalker%2Fkedro-static-viz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WaylonWalker%2Fkedro-static-viz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WaylonWalker","download_url":"https://codeload.github.com/WaylonWalker/kedro-static-viz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221995717,"owners_count":16913549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data","dataengineering","datapipeline","kedro","kedro-plugin","python"],"created_at":"2024-07-31T10:00:20.036Z","updated_at":"2024-10-29T05:31:07.399Z","avatar_url":"https://github.com/WaylonWalker.png","language":"Python","funding_links":["https://github.com/sponsors/WaylonWalker"],"categories":["[Kedro plugins](https://docs.kedro.org/en/stable/extend_kedro/plugins.html)"],"sub_categories":[],"readme":"# [![Kedro-Static-Viz](./artwork/headers/1.png)](https://static-viz.kedro.dev)\r\n\r\nKedro-Static-Viz creates a static website for your [Kedro](https://github.com/quantumblacklabs/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.\r\n\r\n![Python package](https://github.com/WaylonWalker/kedro-static-viz/workflows/Python%20package/badge.svg?branch=master)\r\n\r\n[![PyPI version](https://badge.fury.io/py/kedro-static-viz.svg)](https://badge.fury.io/py/kedro-static-viz)\r\n\r\n\r\n![Build public.tar.gz and Deploy example to gh-pages](https://github.com/WaylonWalker/kedro-static-viz/workflows/Build%20public.tar.gz%20and%20Deploy%20example%20to%20gh-pages/badge.svg?branch=master)\r\n\r\n---\r\n\r\n## ![Example Site](./artwork/headers/2.png)\r\n\r\n\r\nOn every push to master in this repo [static-viz.kedro.dev](https://static-viz.kedro.dev) is built and deployed.\r\n\r\n## ![CLI Usage](./artwork/headers/3.png)\r\n\r\n```\r\nkedro static-viz\r\n```\r\n\r\n## !![Python Usage](./artwork/headers/4.png)\r\n\r\nThe `static_viz` function is callable from inside your project directory.\r\n\r\n```python\r\nfrom kedro_static_viz import static_viz\r\nstatic_viz()\r\n```\r\n\r\n## ![Hooks Usage](./artwork/headers/5.png)\r\n\r\n``` python\r\nfrom kedro_static_viz.hooks import StaticViz\r\n\r\nclass ProjectContext(KedroContext):\r\n   project_name = \"kedro0160\"\r\n   project_version = \"0.16.1\"\r\n   package_name = \"kedro0160\"\r\n   hooks = [ StaticViz() ]\r\n```\r\n\r\n![](./artwork/kedro-static-viz-0-0-1.gif)\r\n\r\n## ![Installation](artwork/headers/6.png)\r\n\r\n\r\n## How do I install and use Kedro-Static-Viz?\r\n\r\n\r\n### As a Kedro Python plugin\r\n\r\nKedro-Static-Viz is available as a Python plugin named `kedro-static-viz`.\r\n\r\nThe following conditions must be true in order to visualise your pipeline:\r\n\r\n- Your project directory must be available to the Kedro-Static-Viz plugin.\r\n- You must be using a [Kedro](https://github.com/quantumblacklabs/kedro) data pipelines project structure with a complete Data Catalog, nodes and pipeline structure.\r\n\r\nTo install it:\r\n\r\n```bash\r\npip install kedro-static-viz\r\n```\r\n\r\nThis will install `kedro` as a dependency, and add `kedro static-viz` as an additional CLI command.\r\n\r\n\r\nTo visualise your pipeline, go to your project root directory and install the project-specific dependencies by running:\r\n\r\n```bash\r\nkedro install\r\n```\r\n\r\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).\r\n\r\nFinally, run the following command from the project directory to visualise your pipeline:\r\n\r\n```bash\r\nkedro static-viz\r\n```\r\n\r\nThis command will run kedro_viz.server on `http://127.0.0.1:4141/` which cannot be accessed from another machine.\r\n\r\nKedro-Viz has a number of options to customise running the visualisation:\r\n\r\n| CLI command              | Description                                                                                                                                                                            |\r\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\r\n| `--port`                 | TCP port that viz will listen to. Defaults to 4141.                                                                                                                                    |\r\n| `--browser/--no-browser` | Whether to open viz interface in the default browser or not.                                                                                                                           |\r\n| `--load-file`            | Path to load the pipeline JSON file                                                                                                                                                    |\r\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. |\r\n| `--env`, `-e`            | Kedro configuration environment. If not specified, catalog config in `local` will be used.                                                                                             |\r\n| `--directory`            | Directory to render the static site to                                                                                                                                                 |\r\n| `--serve/--no-serve`     | Whether or not to serve the site after creating. Defaults to True.                                                                                                                     |\r\n\r\n## ![Contributing](./artwork/headers/7.png)\r\n\r\n**You're Awesome** for considering a contribution!  Contributions are welcome, please check out the [Contributing Guide](./contributing.md) for more information.  Please be a positive member of the community and embrace feedback\r\n\r\n## ![Versioning](./artwork/headers/8.png)\r\n\r\nWe use [SemVer](https://semver.org/) for versioning. For the versions available, see the [tags on this repository](./tags).\r\n\r\n\r\n## ![Authors](./artwork/headers/9.png)\r\n\r\n[![Waylon Walker](https://avatars1.githubusercontent.com/u/22648375?s=120\u0026v=4)](https://github.com/WaylonWalker) - Waylon Walker - _Original Author_\r\n\r\n## ![License](./artwork/headers/10.png)\r\n\r\nThis project is licensed under the MIT License - see the LICENSE file for details\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWaylonWalker%2Fkedro-static-viz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWaylonWalker%2Fkedro-static-viz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWaylonWalker%2Fkedro-static-viz/lists"}