NatLabRockies / NatLabRockies/reView
Update CLIs to use "review" base command
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Why this feature is necessary:
This syntax will make it easier to find available review CLI commands. For our reVX CLI, we have a lot of commands that are not intuitively associated with reVX (e.g., setbacks) while for the reV model we have a reV base command to give the user a nice place to start. I find the latter much more intuitive and easy to work with.
A possible solution is:
Use a generic review CLI with command options. So, you would type review and then the help file would list the available commands. The option would then run the target command, so, something like this:
review make-maps -i input.csv -t wind -o wind_maps/ -d 300
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing reVX CLI and the reV base-command entry point, then review how commands such as make-maps are exposed and documented. Done means users can invoke review, see the available review commands in help, and run the make-maps example through that base command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100