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

Add an option to get an example pipeline in the project creation flow #3076

Closed
merelcht opened this issue Sep 25, 2023 · 0 comments · Fixed by #3295 or kedro-org/kedro-starters#181
Closed
Assignees
Labels
Component: CLI Issue/PR that addresses the CLI for Kedro

Comments

@merelcht
Copy link
Member

merelcht commented Sep 25, 2023

Description

See #2506 (comment)

Depending on the add-ons a user has selected they will get one of the following example pipelines if they opt for the example in the project creation flow:

  1. spaceflights-pandas: didn't select viz or pyspark
  2. spaceflights-pandas-viz: selected viz
  3. spaceflights-pyspark: selected pyspark
  4. spaceflights-pyspark-viz: selected viz & pyspark

To agree on:

Agree with design @amandakys what combination of add-ons impact the example and how. e.g. if the user doesn't want the data structure what happens to the example.

Discussed on 31/10

  • If a users selects the example, but hasn't selected any add-ons we'll still keep the "data" folder structure. This the one exception were the "example" choice is more important than the "add-ons" choice, because the data folder is a different type of add-on, the only structural one compared to the others who are more dependency based. The main reason behind this is because the catalog.yml references the data folder and it would be fiddly to change it.
  • Any other add-ons choices to take precedence, so if the user doesn't want testing, no tests should be included in the example.

Implementation approach

  • Expand the project creation flow to pull all the code needed to get a functioning pipeline.
  • The default choice for example is no
  • Add a CLI flag so the user can also select the example directly when doing kedro new --example=y/n
  • See Iterate on feedback on Project Creation Flow  #3054 for the most up to date design
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment