Skip to content

[python] Add mechanism cli with simple command#8516

Merged
caishunfeng merged 1 commit intoapache:devfrom
zhongjiajie:py-add-cli
Feb 24, 2022
Merged

[python] Add mechanism cli with simple command#8516
caishunfeng merged 1 commit intoapache:devfrom
zhongjiajie:py-add-cli

Conversation

@zhongjiajie
Copy link
Copy Markdown
Member

@zhongjiajie zhongjiajie commented Feb 24, 2022 •
edited
Loading

  • Add basic cli mechanism with Click, for now just including
    one single subcommand version
  • Add general and easy test class in tests/testing/cli, and
    test to version
  • Add sphinx-click to general cli docs basic on click

ref: #8517
close: #8518

@zhongjiajie
[python] Add mechanism cli only with version as subcommand
d505934 
* Add basic cli mechanism with Click, for now just including
  one single subcommand `version`
* Add general and easy test class in tests/testing/cli, and
  test to version
* Add sphinx-click to general cli docs basic on click
@zhongjiajie zhongjiajie self-assigned this Feb 24, 2022
@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

PTAL @devosend @jieguangzhou thanks~

@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

When my PR is just related to some issue instead of a directly closed issue, I prefer to use the keyword ref: #<issue_number> instead of close: #<issue_number>. Because keyword close would directly close the issue when this PR is merged. But in this situation, the target issue contains many sub-issue because it is a DSIP, I do not want to close it when this issue is merged. So I use ref in #8516 (comment)

@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

Our CI runs in GitHub Action https://github.com/features/actions, and the configured is in https://github.com/apache/dolphinscheduler/blob/f3d663a7eaf559e855971e83d593a827196a1aa0/.github/workflows/py-ci.yml.

All you can see in CI run-time windows in this PR with the prefix Python API it created by https://github.com/apache/dolphinscheduler/blob/f3d663a7eaf559e855971e83d593a827196a1aa0/.github/workflows/py-ci.yml

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Feb 24, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

When my PR is just related to some issue instead of a directly closed issue, I prefer to use the keyword ref: #<issue_number> instead of close: #<issue_number>. Because keyword close would directly close the issue when this PR is merged. But in this situation, the target issue contains many sub-issue because it is a DSIP, I do not want to close it when this issue is merged. So I use ref in #8516 (comment)

I add new issue about this PR, so I add close: #8518 just now. when this PR is merge, issue #8518 will auto close by github

@devosend
Copy link
Copy Markdown
Contributor

devosend commented Feb 24, 2022

LGTM

@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

LGTM

Thanks for reviewing. now we need @jieguangzhou for the double-check

jieguangzhou
jieguangzhou approved these changes Feb 24, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@jieguangzhou jieguangzhou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

Thanks~ ping @caishunfeng @songjianet I think this PR could be merged now, PTAL

@zhongjiajie zhongjiajie mentioned this pull request Feb 24, 2022
Open
3 tasks
@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

I create an issue about add auto complete to CLI in #8521

caishunfeng
caishunfeng approved these changes Feb 24, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@caishunfeng caishunfeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@caishunfeng caishunfeng merged commit 3025f67 into apache:dev Feb 24, 2022
@zhongjiajie zhongjiajie deleted the py-add-cli branch February 24, 2022 08:09
@zhongjiajie
Copy link
Copy Markdown
Member Author

zhongjiajie commented Feb 24, 2022

Thanks for merging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@caishunfeng caishunfeng caishunfeng approved these changes

@jieguangzhou jieguangzhou jieguangzhou approved these changes

Assignees

@zhongjiajie zhongjiajie

Labels

feature new feature Pyscheduler

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature][python] Add basic components for CLI

4 participants

@zhongjiajie @devosend @caishunfeng @jieguangzhou