template package importable

Visão geral

Este é o modelo de embalagem que usamos internamente ao criar novos pacotes importáveis ​​baseados em Python. Possui todas as funcionalidades básicas e fluxos de trabalho necessários para criar, criar e publicar um novo pacote para o PYPI.

Este modelo de pacote não fornece nenhuma funcionalidade da CLI, mas foi projetado para criar pacotes importáveis.

Decidimos disponibilizar isso junto com nossas outras ferramentas para permitir que as pessoas usem um ponto de partida bem projetado ao criar suas próprias ferramentas.

Também fornecemos 2 outros modelos que usamos.

• Projeto de modelo Python
• CLI do pacote de modelos

Características

• Arquitetura modular : organize seu código em módulos para obter melhor capacidade de manutenção.
• Exceções personalizadas : exemplos básicos para implementar exceções personalizadas para tratamento de erros específicos.
• Exemplos de teste : exemplos básicos para escrever testes de teste para o seu pacote.

Instalação

Para instalar o pacote importável, clone o repositório e navegue até o diretório do projeto:

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

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

Estrutura do projeto

O projeto está organizado da seguinte forma:

template-package-importable/
├── wolfsoftware/
│   └── template_package_importable/
│       ├── __init__.py
│       ├── exceptions.py
│       └── functions.py
├── tests/
│   ├── __init__.py
│   └── test_template_package_importable.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_importable : contém os módulos principais do aplicativo.
  • exceptions.py : lida com exceções personalizadas.
  • functions.py : define algumas funções de exemplo (para teste).
• tests : onde os testes de pytest estão localizados.
  • test_template_package_importable.py : os testes específicos a serem executados.
• setup.py : a configuração do pacote.
• requirements.txt : lista as dependências necessárias para o projeto.
• README.md : O arquivo que você está lendo no momento.