lincc-frameworks / lincc-frameworks/python-project-template
Command line support in template
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jinja
- Stelle
- 85
- Fork
- 16
- Merge medio
- 6h 18m
- PR unite (30g)
- 1
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con il pyproject.toml del template e l’entry point proposto src/hyrax_cli/main.py. Aggiungi lo script da console hyrax, il parsing di base degli argomenti, la stampa della versione e la documentazione per una CLI do_thing input_file output_file e per i file di configurazione. Il lavoro è completo quando il progetto generato espone una CLI funzionante e spiega come usarla e configurarla.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- cli, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100