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

Revise cookiecutter.json in starters #3483

Closed
DimedS opened this issue Jan 4, 2024 · 0 comments · Fixed by kedro-org/kedro-starters#205
Closed

Revise cookiecutter.json in starters #3483

DimedS opened this issue Jan 4, 2024 · 0 comments · Fixed by kedro-org/kedro-starters#205
Assignees
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@DimedS
Copy link
Member

DimedS commented Jan 4, 2024

Description

Now in our starters we have a cookiecutter.json file with:

{
    "project_name": "Spaceflights Pandas",
    "repo_name": "{{ cookiecutter.project_name.strip().replace(' ', '-').replace('_', '-').lower() }}",
    "python_package": "{{ cookiecutter.project_name.strip().replace(' ', '_').replace('-', '_').lower() }}",
    "kedro_version": "{{ cookiecutter.kedro_version }}",
    "tools": "none",
    "example_pipeline": "no"
}

and when using only starters users don't need "tools" and "example_pipeline" variables, looks like we just put some fake values there to make hooks code work. But it can mislead users, especially when building their own custom starters, where it's not clear why it's necessary to have that variables and what values should we put in and why.

Possible Implementation

I think it will be better to update hooks code to allow using cookiecutter.json without that variables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue: Feature Request New feature or improvement to existing feature
Projects
None yet
3 participants