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

17o2
Copy link
Collaborator

@17o2 17o2 commented Oct 2, 2021

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:

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

bla
@17o2
Add CLI help strings
77f668e
@17o2
Only output requested file types (closes #60)
d3e99ab
@17o2
Fix entry point
b53ce36
@17o2
Split the YAML loading and parsing functions
a5b0fbe
@17o2
Implement image path resolver
6a08988
@17o2
Do not output .gv files by default
b1fa2b9
@17o2
Fix smart file resolver for images
3a181f6
@17o2
Remove obsolete comments
3c6b902
@17o2
Add main() to wireviz.py as fallback
0cb0a4e
@17o2
Add encoding info to wv_cli.py
5b3c2b3
@17o2
Sort --format flags alphabetically
a4343ae
@17o2
Update README for new CLI commands
c68d641
@17o2
Output help string if no arguments are received
d6d1fbc
@17o2
Improve REAME.md
3dae1cb
@17o2
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
17o2 added 17 commits October 16, 2021 22:08
@17o2
Create cache of graph to avoid generating it more than once
65b8e36
@17o2
Add black profile for isort
6f8078e
@17o2
Apply isort
3446154
@17o2
Apply black
f92985a
@17o2
Apply some manual fixes, reapply black
c89cf73
@17o2
Mention isort and black in contribution guidelines
58ab5ca
@17o2
Add 'black' badge to README.md
c702e20
@17o2
Consolidate wireviz.parse() to handle Path, str and Dict as i…
d7d7854 
…nput
@17o2
Allow specifying output directory and file name separately
e353070
@17o2
Add leading underscore to local helper functions
8215113
@17o2
Write docstring for parse() function
3aa1a2e
@17o2
Update build_examples.py
b46d263
@17o2
Automatically include input file directory in list to resolve image p…
5aaea65 
…aths
@17o2
Add support for multiple prepended files
08b5124
@17o2
Make template separator character user-configurable
45bcc1d
@17o2
Simplify file access operations
d19c260
@17o2
Auto-assign missing harness title if reading from file
e31ed72
@17o2 17o2 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
@17o2 17o2 merged commit e31ed72 into feature/technical-drw Aug 5, 2022
@17o2 17o2 deleted the feature/cli branch August 5, 2022 16:33
@martinrieder martinrieder mentioned this pull request Jun 17, 2024
Open
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.
1 participant
@17o2