-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(sdk)!: make CLI output consistent, readable, and usable #7739
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
feat(sdk)!: make CLI output consistent, readable, and usable #7739
Conversation
Skipping CI for Draft Pull Request. |
/test all |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Thanks @connor-mccarthy. I think this change worth having a release note entry.
Thanks, @chensun. Done. I also took this opportunity to add two other CLI-related release notes from PRs merged since the last release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve
Thanks!
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: chensun The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
…w#7739) * fix cli upload pipeline version * organize requirements.in * generate requirements.txt * add pip-tools to requirements-dev * improve CLI output * update release notes
…w#7739) * fix cli upload pipeline version * organize requirements.in * generate requirements.txt * add pip-tools to requirements-dev * improve CLI output * update release notes
Description of your changes:
This PR implements changes to the KFP CLI output.
There are three improvements:
The CLI always outputs something as a confirmation to the developer that their command worked.
The outputs are consistent in the readable (
--output=table
) mode. They consistently adhere to the docker/kubectl table style for improved readability.Example (
kfp run list -m 3
):--output=json
) mode, the CLI merely passes all the JSON it receives from the backend on tostdout
, instead of filtering and renaming fields. This makes the output much more complete/usable/consistent (e.g. can be parsed withjq
and more fields are available) for CLI users, makes the response payloads from the different KFP API clients more consistent, and decreases ongoing maintenance costs for KFP developers.Checklist:
repository.