CLI command kedro viz build added #1697

jitu5 · 2024-01-04T16:24:56Z

Description

Resolves #1615. Add kedro viz build to build directory of local Kedro Viz instance with static data.

Development notes

Utilized a combination of inheritance and the factory pattern.
Introduced a base class called "BaseDeployer" which encapsulates the core deployment logic.
Created two specialized child classes: "LocalDeployer" and "S3Deployer:
- "LocalDeployer" is responsible for copying the build and API folders to the kedro-project folder locally without cloud deployment.
- "S3Deployer" handles the task of uploading the same content to an S3 bucket.

Adopted this design pattern with the flexibility to easily extend to other cloud platforms like Azure and GCP in the future.

QA notes

Install editable kedro viz via pip install -e package
cd demo-project
Run kedro viz build

Checklist

Read the contributing guidelines
Opened this PR as a 'Draft Pull Request' if it is work-in-progress
Updated the documentation to reflect the code changes
Added new entries to the RELEASE.md file
Added tests to cover my changes

package/kedro_viz/launchers/cli.py

README.md

Signed-off-by: ravi-kumar-pilla <ravi_kumar_pilla@mckinsey.com>

…o-viz into feature/cli-build # Conflicts: # package/kedro_viz/integrations/deployment/base_deployer.py # package/tests/test_integrations/test_base_deployer.py

# Conflicts: # RELEASE.md

SajidAlamQB

This is awesome work @jitu5! 🌟

The implementation looks great just left a minor comment.

package/kedro_viz/integrations/deployment/base_deployer.py

merelcht

I left some small comments, but generally the implementation looks very neat to me 🙂

package/kedro_viz/integrations/deployment/base_deployer.py

package/kedro_viz/launchers/cli.py

…o-viz into feature/cli-build

noklam · 2024-01-15T16:07:08Z

README.md

+
+```bash
+kedro viz build
+```
+


Should we have some docs explaining how to view this build?

yes, in another PR we will focus on the build docs

noklam

Thanks! This is a really nice implementation and very close to what I had in mind. It should be relative straightforward to expand the deploy command and add other targets from here.

Great work!

merelcht

I left one minor comment, but otherwise this looks great! 👍 ⭐

merelcht · 2024-01-16T10:54:06Z

package/kedro_viz/integrations/deployment/deployer_factory.py

+            return S3Deployer(region, bucket_name)
+        if platform == "local":
+            return LocalDeployer()
+        raise ValueError("Invalid platform specified")


It could be useful to add what the value of "platform" given was, so it's easier to debug. E.g. "Invalid platform bla specified"

Updated, Thanks.

ravi-kumar-pilla

Awesome work !!

NeroOkwa

Amazing !

CLI command kedro viz build added

66f177d

jitu5 added the Python Pull requests that update Python code label Jan 4, 2024

jitu5 requested a review from ravi-kumar-pilla January 4, 2024 16:24

jitu5 self-assigned this Jan 4, 2024

jitu5 requested review from tynandebold, yetudada and rashidakanchwala as code owners January 4, 2024 16:24

jitu5 added 4 commits January 4, 2024 17:09

Lint fix

cc7c144

lint fix

a389a83

Lint fix

6528d36

add mypy ignore

5a9f2e1

ravi-kumar-pilla reviewed Jan 5, 2024

View reviewed changes

package/kedro_viz/launchers/cli.py Show resolved Hide resolved

jitu5 marked this pull request as draft January 5, 2024 11:43

jitu5 added 2 commits January 8, 2024 09:59

Missing build file added

b86b578

Lint error fix

40003f8

tynandebold reviewed Jan 8, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

jitu5 and others added 14 commits January 9, 2024 19:42

BaseDeployer class added

0c879a8

Unused code removed

5145ba4

Fix lint issue

26f6275

added base_deployer

c7ed79c

latest

11ac321

add deployer factory

42af3af

Test and comments of deployers updated

7ad0905

fix lint

2a4e00f

Signed-off-by: ravi-kumar-pilla <ravi_kumar_pilla@mckinsey.com>

remove circular dependency

ecb6a05

Signed-off-by: ravi-kumar-pilla <ravi_kumar_pilla@mckinsey.com>

Tests and lint fixes

90c285b

Merge branch 'feature/cli-build' of https://github.com/kedro-org/kedr…

eadb85c

…o-viz into feature/cli-build # Conflicts: # package/kedro_viz/integrations/deployment/base_deployer.py # package/tests/test_integrations/test_base_deployer.py

Import fixes

d579bb7

Lint fixes

e8e25fa

Lint fixes

0ad5301

jitu5 and others added 3 commits January 15, 2024 10:13

Merge branch 'main' into feature/cli-build

98f11b2

# Conflicts: # RELEASE.md

fix lint

2ffc777

fix return on deploy_get_url

4c977a6

rashidakanchwala marked this pull request as ready for review January 15, 2024 12:20

rashidakanchwala requested review from merelcht, noklam and SajidAlamQB and removed request for yetudada January 15, 2024 12:20

SajidAlamQB approved these changes Jan 15, 2024

View reviewed changes

package/kedro_viz/integrations/deployment/base_deployer.py Show resolved Hide resolved

merelcht reviewed Jan 15, 2024

View reviewed changes

package/kedro_viz/integrations/deployment/base_deployer.py Outdated Show resolved Hide resolved

package/kedro_viz/launchers/cli.py Outdated Show resolved Hide resolved

jitu5 added 2 commits January 15, 2024 14:31

Exception and class method updated

d51634f

Merge branch 'feature/cli-build' of https://github.com/kedro-org/kedr…

35b9775

…o-viz into feature/cli-build

noklam reviewed Jan 15, 2024

View reviewed changes

noklam approved these changes Jan 15, 2024

View reviewed changes

jitu5 requested a review from NeroOkwa January 16, 2024 10:25

merelcht approved these changes Jan 16, 2024

View reviewed changes

User entered platform added in error

0297a5f

rashidakanchwala approved these changes Jan 16, 2024

View reviewed changes

jitu5 and others added 2 commits January 16, 2024 11:29

Fix test

b27cdaf

Merge branch 'main' into feature/cli-build

932e654

jitu5 merged commit 20dc420 into main Jan 16, 2024
17 checks passed

jitu5 deleted the feature/cli-build branch January 16, 2024 15:38

ravi-kumar-pilla reviewed Jan 17, 2024

View reviewed changes

NeroOkwa reviewed Jan 19, 2024

View reviewed changes

jitu5 mentioned this pull request Jan 22, 2024

Release v7.1.0 #1713

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLI command kedro viz build added #1697

CLI command kedro viz build added #1697

jitu5 commented Jan 4, 2024 •

edited by rashidakanchwala

Loading

SajidAlamQB left a comment

merelcht left a comment

noklam Jan 15, 2024

rashidakanchwala Jan 15, 2024

noklam left a comment

merelcht left a comment

merelcht Jan 16, 2024

jitu5 Jan 16, 2024

ravi-kumar-pilla left a comment

NeroOkwa left a comment •

edited

Loading

CLI command kedro viz build added #1697

CLI command kedro viz build added #1697

Conversation

jitu5 commented Jan 4, 2024 • edited by rashidakanchwala Loading

Description

Development notes

QA notes

Checklist

SajidAlamQB left a comment

Choose a reason for hiding this comment

merelcht left a comment

Choose a reason for hiding this comment

noklam Jan 15, 2024

Choose a reason for hiding this comment

rashidakanchwala Jan 15, 2024

Choose a reason for hiding this comment

noklam left a comment

Choose a reason for hiding this comment

merelcht left a comment

Choose a reason for hiding this comment

merelcht Jan 16, 2024

Choose a reason for hiding this comment

jitu5 Jan 16, 2024

Choose a reason for hiding this comment

ravi-kumar-pilla left a comment

Choose a reason for hiding this comment

NeroOkwa left a comment • edited Loading

Choose a reason for hiding this comment

jitu5 commented Jan 4, 2024 •

edited by rashidakanchwala

Loading

NeroOkwa left a comment •

edited

Loading