lincc-frameworks / lincc-frameworks/python-project-template
Command line support in template
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Jinja
- Estrelas
- 85
- Forks
- 16
- Merge médio
- 6h 18min
- PRs com merge (30d)
- 1
Descrição
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.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece com o pyproject.toml do template e o ponto de entrada proposto src/hyrax_cli/main.py. Adicione o script de console hyrax, o parsing básico de argumentos, a impressão da versão e a documentação para uma CLI do_thing input_file output_file e para arquivos de configuração. Está concluído quando o projeto gerado expõe uma CLI funcional e explica como usá-la e configurá-la.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- cli, documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100