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.

Sign up for GitHub

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

Jump to bottom

Clean up and improve CLI implementation #244

Merged
merged 35 commits into from
Aug 5, 2022
Merged

Clean up and improve CLI implementation #244

merged 35 commits into from
Aug 5, 2022

Conversation

formatc1702
Copy link
Collaborator

This is a refactoring of the WireViz CLI.

Main points

  • Use the Click package for more elegant CLI handling
  • Move the CLI handling to a new file wv_cli.py
  • Remove all CLI code from wireviz.py
  • Change the entry point in setup.py

This PR should address the following issues:

@formatc1702 formatc1702 changed the base branch from master to dev October 2, 2021 10:36
@formatc1702 formatc1702 force-pushed the feature/cli branch 2 times, most recently from b5fd081 to e1620eb Compare October 2, 2021 11:05
@formatc1702 formatc1702 changed the title Clenaer CLI implementation Cleaner CLI implementation Oct 2, 2021
@formatc1702 formatc1702 mentioned this pull request Oct 2, 2021
Merged
@formatc1702 formatc1702 changed the base branch from dev to feature/pathlib October 15, 2021 13:10
@formatc1702 formatc1702 mentioned this pull request Oct 15, 2021
Open
@formatc1702 formatc1702 marked this pull request as ready for review October 15, 2021 15:42
@formatc1702 formatc1702 changed the title Cleaner CLI implementation Clean up and improve CLI implementation Oct 16, 2021
@formatc1702
Add wv_cli.py, add Click requirement, change entry point
a810bd5
@formatc1702
Implement working proof of concept
1df45ab
@formatc1702
Remove unneeded code from wireviz.py
19481b2 
Re-add `parse_file()` for building examples

bla
@formatc1702
Add CLI help strings
77f668e
@formatc1702
Only output requested file types (closes #60)
d3e99ab
@formatc1702
Fix entry point
b53ce36
@formatc1702
Split the YAML loading and parsing functions
a5b0fbe
@formatc1702
Implement image path resolver
6a08988
@formatc1702
Do not output .gv files by default
b1fa2b9
@formatc1702
Fix smart file resolver for images
3a181f6
@formatc1702
Remove obsolete comments
3c6b902
@formatc1702
Add main() to wireviz.py as fallback
0cb0a4e
@formatc1702
Add encoding info to wv_cli.py
5b3c2b3
@formatc1702
Sort --format flags alphabetically
a4343ae
@formatc1702
Update README for new CLI commands
c68d641
@formatc1702
Output help string if no arguments are received
d6d1fbc
@formatc1702
Improve REAME.md
3dae1cb
@formatc1702
Split file output logic and object return logic
fb2aae5 
Use `output_formats` parameter to specify which *files* to output to disk,
Use `return_types` parameter to specify which objects to return to a calling Python script
@formatc1702
Create cache of graph to avoid generating it more than once
65b8e36
@formatc1702
Add black profile for isort
6f8078e
@formatc1702
Apply isort
3446154
@formatc1702
Apply black
f92985a
@formatc1702
Apply some manual fixes, reapply black
c89cf73
@formatc1702
Mention isort and black in contribution guidelines
58ab5ca
@formatc1702
Add 'black' badge to README.md
c702e20
@formatc1702
Consolidate wireviz.parse() to handle Path, str and Dict as i…
d7d7854 
…nput
@formatc1702
Allow specifying output directory and file name separately
e353070
@formatc1702
Add leading underscore to local helper functions
8215113
@formatc1702
Write docstring for parse() function
3aa1a2e
@formatc1702
Update build_examples.py
b46d263
@formatc1702
Automatically include input file directory in list to resolve image p…
5aaea65 
…aths
@formatc1702
Add support for multiple prepended files
08b5124
@formatc1702
Make template separator character user-configurable
45bcc1d
@formatc1702
Simplify file access operations
d19c260
@formatc1702
Auto-assign missing harness title if reading from file
e31ed72
@formatc1702 formatc1702 mentioned this pull request Aug 5, 2022
Open
5 tasks
Base automatically changed from feature/pathlib to feature/technical-drw August 5, 2022 16:29
@formatc1702 formatc1702 merged commit e31ed72 into feature/technical-drw Aug 5, 2022
@formatc1702 formatc1702 deleted the feature/cli branch August 5, 2022 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@formatc1702