lincc-frameworks / lincc-frameworks/python-project-template
Command line support in template
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jinja
- Sterne
- 85
- Forks
- 16
- Ø Merge
- 6 Std. 18 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der pyproject.toml der Vorlage und dem vorgeschlagenen Einstiegspunkt src/hyrax_cli/main.py. Füge das hyrax-Konsolenskript, die grundlegende Argumentanalyse, die Ausgabe der Version und eine Dokumentation für eine do_thing input_file output_file-CLI sowie Konfigurationsdateien hinzu. Als erledigt gilt die Aufgabe, wenn das generierte Projekt eine funktionierende CLI bereitstellt und erklärt, wie sie verwendet und konfiguriert wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- cli, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100