Skip to content

Commit

Permalink
Merge branch 'main' into feature/watchfiles
Browse files Browse the repository at this point in the history
  • Loading branch information
jitu5 authored Oct 11, 2024
2 parents 28649b6 + e83fc62 commit 9d2bf63
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
2 changes: 2 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ Please follow the established format:

## Bug fixes and other changes

- Improve `kedro viz build` usage documentation (#2126)
- Fix unserializable parameters value (#2122)
- Replace `watchgod` library with `watchfiles` (#2134)


# Release 10.0.0

## Major features and improvements
Expand Down
28 changes: 28 additions & 0 deletions docs/source/platform_agnostic_sharing_with_kedro_viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,34 @@ Starting from Kedro-Viz 9.2.0, `kedro viz build` will not include dataset previe

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:
```bash
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:
```bash
npm install -g http-server
```
- Then, run it from the build directory:
```bash
http-server
```
```{warning}
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](https://docs.github.com/en/pages/quickstart) 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`
4 changes: 2 additions & 2 deletions package/tests/test_models/test_flowchart.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from functools import partial
from pathlib import Path
from textwrap import dedent
from unittest.mock import Mock, call, patch
from unittest.mock import call, patch

import pytest
from kedro.io import MemoryDataset
Expand Down Expand Up @@ -232,7 +232,7 @@ def test_create_single_parameter_with_complex_type(self):
assert isinstance(parameters_node.parameter_value, str)

def test_create_all_parameters_with_complex_type(self):
mock_object = Mock()
mock_object = object()
parameters_dataset = MemoryDataset(
data={
"test_split_ratio": 0.3,
Expand Down

0 comments on commit 9d2bf63

Please sign in to comment.