Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change kedro viz to kedro viz run, make viz a command group #1616

Closed
2 tasks
amandakys opened this issue Oct 30, 2023 · 1 comment
Closed
2 tasks

Change kedro viz to kedro viz run, make viz a command group #1616

amandakys opened this issue Oct 30, 2023 · 1 comment
Assignees
Labels
Design: Technical UX Issue: Feature Request Python Pull requests that update Python code

Comments

@amandakys
Copy link

amandakys commented Oct 30, 2023

Description

To support #1636 kedro viz deploy command, kedro viz needs to become a command group.

This work needs to be preceded by #1625 to highlight to users that in a future release, the kedro viz command will no longer work

This should be supported by an informative error message

>> kedro viz 

Did you mean this? 
  kedro viz run 
    
Usage: kedro viz [OPTIONS] COMMAND [ARGS]
    
Options:
  -h, --help Show this message and exit 
  
Commands: 
  run         Launch local Kedro Viz instance         
  deploy      Deploy Kedro Viz to a hosted link with AWS 
  build       Create build directory of local Kedro Viz instance with static data 

*Note: the deploy and build help text can be added when those commands are implemented, rather than as part of this ticket

Acceptance Criteria

  • working kedro viz run command, that launched Kedro viz (same functionality as current kedro viz
  • when users run kedro viz they receive useful help text prompting them to use kedro viz run instead
@tynandebold tynandebold added this to the Shareable URLs milestone Oct 31, 2023
@amandakys amandakys changed the title [wip] Change kedro viz to kedro viz run, make viz a command group Change kedro viz to kedro viz run, make viz a command group Nov 10, 2023
@tynandebold tynandebold added the Python Pull requests that update Python code label Nov 13, 2023
@datajoely
Copy link
Contributor

is there a confusion with kedro run what about kedro viz up like docker compose up?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design: Technical UX Issue: Feature Request Python Pull requests that update Python code
Projects
None yet
Development

No branches or pull requests

6 participants