apache/dolphinscheduler

[Feature][python] Auto completion to CLI

Open

#8,521 opened on Feb 24, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (4,324 forks)batch import
Pyschedulerfeaturehelp wanted

Repository metrics

Stars
 (11,659 stars)
PR merge metrics
 (Avg merge 2d 21h) (22 merged PRs in 30d)

Description

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

In #8516, we just add add basic use of CLI, it could be better if we add auto completion to it. whcih mean when user use

pydolphinscheduler <TAB>

in Bash, we will auto show the subcommand for them, just like below

pydolphinscheduler <TAB>

version

Use case

No response

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Contributor guide

Research direction
Explore adding auto completion to the pydolphinscheduler CLI using argparse's built in completion or click's shell completion. Generate completion scripts for bash/zsh and integrate with the entry point.
Tech stack
python
Domain
clideveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonCLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75