lincc-frameworks / lincc-frameworks/python-project-template
Command line support in template
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Jinja
- Estrellas
- 85
- Forks
- 16
- Merge medio
- 6 h 18 min
- PR fusionados (30 d)
- 1
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza con el pyproject.toml de la plantilla y el punto de entrada propuesto src/hyrax_cli/main.py. Añade el script de consola hyrax, el análisis básico de argumentos, la impresión de la versión y documentación para una CLI do_thing input_file output_file y para los archivos de configuración. Se considera terminado cuando el proyecto generado expone una CLI funcional y explica cómo usarla y configurarla.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- cli, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100