template package cli

Visão geral

Este é o modelo de embalagem que usamos internamente ao criar novas ferramentas baseadas em Python CL. Possui todas as funcionalidades básicas e fluxos de trabalho necessários para criar, criar e publicar um novo pacote para o PYPI.

Este pacote fornece um utilitário de linha de comando para processamento e manuseio de várias tarefas usando um conjunto de argumentos e configurações predefinidos. O projeto tem como objetivo servir como uma linha de base para o desenvolvimento de aplicativos de linha de comando semelhantes.

Ele inclui recursos como análise de argumentos, gerenciamento de configuração e uma estrutura modular para facilitar o desenvolvimento de código escalável e sustentável.

Também fornecemos 2 outros modelos que usamos.

• Projeto de modelo Python
• pacote de modelos importáveis

Características

• Arquitetura modular : organize seu código em módulos para obter melhor capacidade de manutenção.
• Analisação de argumentos : lida facilmente com argumentos da linha de comando usando argparse .
• Gerenciamento de configuração : gerar objetos de configuração a partir de argumentos da linha de comando.
• Exceções personalizadas : implemente exceções personalizadas para manuseio de erros específicos.

Instalação

Para instalar o pacote da CLI, clone o repositório e navegue até o diretório do projeto:

git clone https://github.com/DevelopersToolbox/template-package-cli.git
cd template-package-cli

Recomenda -se usar um ambiente virtual para gerenciar dependências. Você pode criar e ativar um ambiente virtual usando os seguintes comandos:

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

Instale as dependências necessárias:

pip install -r requirements.txt

Uso

Para executar o pacote da CLI, execute a função main do script principal:

python -m wolfsoftware.template_package_cli.main --required < value >

Argumentos da linha de comando

O aplicativo suporta vários argumentos da linha de comando:

• -h, --help : mostre mensagem de ajuda e saída.
• -d, --debug : Ativar modo de depuração para saída detalhada.
• -v, --verbose : Ative a saída detalhada para mostrar os resultados da varredura à medida que entram.
• -V, --version : mostre o número da versão e a saída do programa.
• -i, --optional-integer : um argumento inteiro opcional (padrão: 2).
• -s, --optional-string : um argumento opcional de string (padrão: "me").
• -r, --required : um argumento de string necessário.

Exemplo de uso:

python -m wolfsoftware.template_package_cli.main -r " required_value " -i 10 -s " optional_string " 

Estrutura do projeto

O projeto está organizado da seguinte maneira:

template-package-cli/
├── wolfsoftware/
│   └── template_package_cli/
│       ├── __init__.py
│       ├── cli.py
│       ├── config.py
│       ├── exceptions.py
│       ├── globals.py
│       └── main.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_cli : contém os módulos principais do aplicativo.
  • cli.py : lida com os argumentos da linha de comando e o fluxo principal do programa.
  • config.py : lida com a criação de configuração a partir de argumentos da linha de comando.
  • exceptions.py : lida com exceções personalizadas.
  • globals.py : define constantes globais usadas em todo o aplicativo.
  • main.py : o script principal que orquestra a análise de argumentos e a execução do programa.
• requirements.txt : lista as dependências necessárias para o projeto.
• README.md : O arquivo que você está lendo no momento.