lincc-frameworks / lincc-frameworks/python-project-template

Command line support in template

Ouverte
#561 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Jinja
Étoiles
85
Forks
16
Merge moyen
6 h 18 min
PR mergées (30 j)
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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le pyproject.toml du modèle et le point d’entrée proposé src/hyrax_cli/main.py. Ajoutez le script de console hyrax, l’analyse de base des arguments, l’affichage de la version et la documentation d’une CLI do_thing input_file output_file ainsi que des fichiers de configuration. Le travail est terminé lorsque le projet généré expose une CLI fonctionnelle et explique comment l’utiliser et la configurer.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
cli, documentation
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.