Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 3.45 KB

platform_agnostic_sharing_with_kedro_viz.md

File metadata and controls

79 lines (53 loc) · 3.45 KB
Raw

Platform-agnostic sharing with Kedro-Viz

Introduced in Kedro-Viz version 7.1.0, the kedro viz build command allows seamless publishing and sharing of Kedro-Viz on any static website hosting platform. Running this command from the CLI generates a build folder within your Kedro project, containing a static Kedro-Viz app package.

This page describes how to publish Kedro-Viz on a static website hosting platform using kedro viz build. It uses the spaceflights tutorial as an example.

Setup your kedro project

If you haven't installed Kedro {doc}follow the documentation to get set up<kedro:get_started/install>.

We recommend that you use the same version of Kedro that was most recently used to test this tutorial (0.19.1). To check the version installed, type `kedro -V` in your terminal window.
  1. In your terminal window, navigate to the folder you want to store the project. Generate the spaceflights tutorial project with all the code in place by using the Kedro starter for the spaceflights tutorial:
kedro new --starter=spaceflights-pandas

When prompted for a project name, you can enter anything, but we will assume Spaceflights throughout.

  1. When your project is ready, navigate to the root directory of the project. Install the dependencies from the project root directory by typing the following in your terminal:
pip install -r requirements.txt
  1. Kedro-Viz requires specific minimum versions of fsspec, and kedro to publish your project. Ensure you have these correct versions by updating the requirements.txt file of the Kedro project to add the following:
fsspec>=2023.9.0
kedro>=0.18.2
  1. Execute the following command from your project's root directory:
kedro viz build
Starting from Kedro-Viz 9.2.0, `kedro viz build` will not include dataset previews by default. To enable previews for all the datasets, use the `--include-previews` flag.

This creates a build folder containing your Kedro-Viz app package in your project directory.

Running Kedro-Viz Locally

When you generate the build folder using the command kedro viz build, it creates a build directory with an index.html file, which serves as the entry point for visualizing your pipeline.

To view your pipeline visualization correctly, you need to serve index.html using an HTTP server. Here are a few simple ways to do this:

  1. Python's Built-in HTTP Server:

    • Navigate to the build directory and run: 
      python -m http.server
    • This starts a web server at http://localhost:8000, which you can use to view index.html.

  2. Node's http-server:

    • First, install it globally: 
      npm install -g http-server
    • Then, run it from the build directory: 
      http-server
Simply opening `index.html` using the `file://` protocol is not supported due to Cross-Origin Resource Sharing (CORS) policies in modern browsers.

Static website hosting platforms such as GitHub Pages

Follow the steps listed in the GitHub pages documentation to create a Git repository that supports GitHub Pages. On completion, push the contents of the previously created build folder to this new repository. Your site will be available at the following URL: http://<username>.github.io