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

Provide more helpful message for kedro airflow create -h #244

Closed
noklam opened this issue Jun 19, 2023 · 2 comments
Closed

Provide more helpful message for kedro airflow create -h #244

noklam opened this issue Jun 19, 2023 · 2 comments
Labels
good first issue Good for newcomers help wanted Contribution task, outside help would be appreciated!

Comments

@noklam
Copy link
Contributor

noklam commented Jun 19, 2023

Description

Is your feature request related to a problem? A clear and concise description of what the problem is: "I'm always frustrated when ..."

image

The current CLI help message isn't very clear, we can probably reuse some of the message from kedro or just copy it over.

Context

Why is this change important to you? How would you use it? How can it benefit other users?

Possible Implementation

(Optional) Suggest an idea for implementing the addition or change.

Possible Alternatives

(Optional) Describe any alternative solutions or features you've considered.

@noklam noklam added help wanted Contribution task, outside help would be appreciated! Community Issue/PR opened by the open-source community good first issue Good for newcomers and removed Community Issue/PR opened by the open-source community labels Jul 3, 2023
@ankatiyar
Copy link
Contributor

I believe this has more or less been completed by @sbrugman. #233

Usage: kedro airflow create [OPTIONS]

  Create an Airflow DAG for a project

Options:
  -p, --pipeline TEXT         Name of the registered pipeline to convert. If
                              not set, the '__default__' pipeline is used.
  -e, --env TEXT              Kedro configuration environment name. Defaults
                              to `local`.
  -t, --target-dir DIRECTORY  The directory path to store the generated
                              Airflow dags
  -j, --jinja-file FILE       The template file for the generated Airflow dags
  --params TEXT               Specify extra parameters that you want to pass
                              to the context initialiser. Items must be
                              separated by comma, keys - by colon or equals
                              sign, example: param1=value1,param2=value2. Each
                              parameter is split by the first comma, so
                              parameter values are allowed to contain colons,
                              parameter keys are not. To pass a nested
                              dictionary as parameter, separate keys by '.',
                              example: param_group.param1:value1.
  -h, --help                  Show this message and exit.

@astrojuanlu
Copy link
Member

Further improvements always welcome of course :) Closing for now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Contribution task, outside help would be appreciated!
Projects
Archived in project
Development

No branches or pull requests

3 participants