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

Rewrite CLI using Typer #326

Merged
merged 4 commits into from May 9, 2023
Merged

Rewrite CLI using Typer #326

merged 4 commits into from May 9, 2023

Conversation

leroyvn
Copy link
Member

@leroyvn leroyvn commented May 4, 2023

Description

This PR rewrites our CLI with the Typer framework. Argument support and docs are a little nicer and we get nice Rich-based formatting. @nollety, @wint3ria please let me know what you think. Please note that the diff for this PR is provisional, since it should be considered for merge only after #324.

Sample screenshots:

image

image

To do

  • Update dependencies
  • Update CLI documentation system

Checklist

  • The code follows the relevant coding guidelines
  • The code generates no new warnings
  • The code is appropriately documented
  • The code is tested to prove its function
  • The feature branch is rebased on the current state of the main branch
  • I updated the change log if relevant
  • I give permission that the Eradiate project may redistribute my contributions under the terms of its license

@wint3ria
Copy link
Contributor

wint3ria commented May 4, 2023

It's nice

@leroyvn leroyvn force-pushed the typer branch 4 times, most recently from afc754b to 3eaa0e3 Compare May 5, 2023 12:24
@leroyvn
Copy link
Member Author

leroyvn commented May 5, 2023

New docs: https://eradiate.readthedocs.io/en/typer/src/reference_cli.html
vs old: https://eradiate.readthedocs.io/en/v0.23.1/rst/reference_cli/index.html

Sectioning is better but can be further improved. We get rid of sphinx-click and can better customize the CLI documentation, so it's overall an improvement.

@leroyvn leroyvn force-pushed the typer branch 3 times, most recently from 9db0595 to bb6cf49 Compare May 9, 2023 08:51
@leroyvn leroyvn marked this pull request as ready for review May 9, 2023 09:49
@leroyvn leroyvn merged commit d2cb15f into main May 9, 2023
@leroyvn leroyvn deleted the typer branch May 9, 2023 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants