lincc-frameworks / lincc-frameworks/python-project-template
Command line support in template
Open
Nobody has claimed this yet.
- Dominant language
- Jinja
- Stars
- 85
- Forks
- 16
- Avg merge
- 6h 18m
- Merged PRs (30d)
- 1
Description
Add question for adding a command line interface
Will add to the pyproject.toml:
[project.scripts]
hyrax = "hyrax_cli.main:main"
Create some CLI entry point
- e.g. /src/hyrax_cli/main.py
- has all of the bits for a main method, and basic argparsing (and version printing).
Additional documentation:
- how to make a CLI for do_thing input_file output_file
- how to create config files, to trim the number of CLI arguments.
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 with the template's pyproject.toml and the proposed src/hyrax_cli/main.py entry point. Add the hyrax console script, basic argument parsing, version printing, and documentation for a do_thing input_file output_file CLI and configuration files. Done means the generated project exposes a working CLI and explains how to use and configure it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100