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

Addition --name -n argument for kedro new in non-interactive mode #2865

Closed
noklam opened this issue Jul 30, 2023 · 8 comments · Fixed by #3235
Closed

Addition --name -n argument for kedro new in non-interactive mode #2865

noklam opened this issue Jul 30, 2023 · 8 comments · Fixed by #3235
Assignees
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@noklam
Copy link
Contributor

noklam commented Jul 30, 2023

Description

When you have created a Kedro project and execute a kedro command on the CLI for the first time it asks a <project_name>. This is annoying when you keep creating new project, or need to create project with non-interactive mode.

Currently the workaround looks like:
yes project | kedro new -s pandas-iris

The task is to add an option to kedro new to immediately

Context

When running kedro new, it will prompt you to enter the project name. It takes some time for cookiecutter to download the repository and user are stuck until it finished. It would be a nice-to-have if I can give a name argument so I can create the project in 1 command instead of 2.

What this is not

  • We should not make this a mandatory argument. We should keep the current behavior when -n is not provided, then prompt user to input the name of the project.

(kedro_core) kedro_gallery master % kedro new -s pandas-iris

Project Name

Please enter a human readable name for your new project.
Spaces, hyphens, and underscores are allowed.
[Iris]:

Possible Implementation

kedro new -s pandas-iris -n my-pandas - introduce a new argument

This should be very easy to implement.

Possible Alternatives

@noklam noklam added the Issue: Feature Request New feature or improvement to existing feature label Jul 30, 2023
@Galileo-Galilei
Copy link
Member

I've been looking for this in a loooong time, i definitely upvote this!

@noklam noklam changed the title Addition --name -n argument for kedro new? Addition --name -n argument for kedro new Jul 30, 2023
@astrojuanlu
Copy link
Member

Tangentially related #1692

@datajoely
Copy link
Contributor

datajoely commented Jul 31, 2023

Can I also ask for telemetry consent at this point as well? For CI/CD workflows this is critical.

@noklam
Copy link
Contributor Author

noklam commented Jul 31, 2023

Can I also ask for telemetry consent at this point as well? For CI/CD workflows this is critical.
Relate to

This has been design in technical design, but I guess we haven't turn that into concrete issue. I have convert them into issues and put it in backlog

@deepyaman
Copy link
Member

There are a lot of assignees, so I'm a bit confused, but can I take this? I've already implemented this for a private Kedro-ish fork, so I'll just copy it.

@merelcht merelcht removed their assignment Oct 26, 2023
@merelcht
Copy link
Member

There are a lot of assignees, so I'm a bit confused, but can I take this? I've already implemented this for a private Kedro-ish fork, so I'll just copy it.

AFAIK @lrcouto and @DimedS started working on this, so you might want to check with them 🙂

@lrcouto
Copy link
Contributor

lrcouto commented Oct 26, 2023

I've started working on this yesterday. It's gonna need a bit of cleanup on the new CLI function on top of adding the new flag IMO.

@merelcht merelcht moved this from To Do to In Progress in Kedro Framework Oct 26, 2023
@DimedS DimedS linked a pull request Oct 30, 2023 that will close this issue
7 tasks
@lrcouto lrcouto moved this from In Progress to In Review in Kedro Framework Oct 31, 2023
@astrojuanlu
Copy link
Member

Closed in #3235 🎉

@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Nov 1, 2023
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
Archived in project
Development

Successfully merging a pull request may close this issue.

8 participants