bootstrap python package

Bootstrap-Python-Package

Este repositório de modelo fornece o caldeira para criar um pacote python. Ele está configurado com todos os seguintes recursos:

• Suíte de teste usando Tox e Pytest
• Digitando usando mypy
• Formato de linha, segurança e código usando Ruff (usando regras de estilo de código preto e segurança de bandidos)
• Integração com o codeclimate para a qualidade do código e verificações de cobertura
• Pipeline CI Suporte:
  • Testes contra várias versões Python
  • Lançamentos no Pypi
  • Documentação do Github Pages usando MKDOCS
• Configuração básica do perfil de Pycharm

Como usar este modelo de repositório para criar um novo pacote

• Crie seu repositório do GitHub usando este modelo. (O Big Green Use this template )
• Renomeie o diretório bootstrap_python_package
• Pesquise e substitua todas as ocorrências de bootstrap-python-package e bootstrap_python_package
• Configure um editor confiável pendente no Pypi usando os seguintes valores:
  • Nome do projeto Pypi: o nome do repositório do GitHub (neste caso bootstrap-python-package )
  • Proprietário: O Proprietário do Repositório do Github (neste caso, febus982 )
  • Nome do repositório: o nome do repositório do github (neste caso bootstrap-python-package )
  • Nome do fluxo de trabalho: release.yml
• Crie uma ação do github Secret nomeado CODECLIMATE_REPORTER_ID (em url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ). Se você não quiser usar o codeclimate, apenas exclua workflows/python-quality.yml .
• Atualize os crachás no README.md ! (Verifique Shields.io para obter emblemas extras)
• Atualize o perfil de direitos autorais do PyCharm nas configurações do IDE: Editor | Direitos autorais | Perfis de direitos autorais (se você quiser usá -lo)
• Configure o desenvolvimento local:
  • Clone o repositório
  • Instalar poesia pip install poetry
  • Instale dependências dev com make dev-dependencies
  • (Opcional) É altamente recomendável instalar pré-compromisso e execução pre-commit install para que a formatação e o linha sejam executados automaticamente durante git commit .
• Configurar páginas do github (que precisam de configuração de desenvolvimento local):
  • Poesia de documentação inicializa poetry run mike deploy dev latest --update-aliases --push
  • Configure as páginas do Github a serem implantadas na filial gh-pages (em URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • Adicione https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments lista main e a tag V gh-pages v*.*.*

IMPORTANTE: O repositório é configurado para implantar no repositório de teste PYPI. É fortemente recomendado criar o projeto no repositório de teste PYPI e testar o pipeline de implantação. Quando estiver satisfeito com o resultado, crie o projeto no repositório oficial do PyPI e remova as linhas marcadas nos workflows/release.yml .

Liberação do pacote

Esta configuração usa verificação de poesia-dinâmica. Isso significa que não é necessário comprometer a versão no código, mas o pipeline do CI o inferirá da tag git.

Para lançar uma nova versão, basta criar um novo lançamento e tag no repositório do GitHub, para:

• Construa e implante o pacote Python para Pypi
• Construa e implante uma nova versão da documentação nas páginas do GitHub

IMPORTANTE: A configuração padrão requer o nome da liberação e a tag para seguir a convenção vX.XX (versão semântica precedida pelo minúsculo v ). Ele publicará a versão correta no Pypi, omitindo o v (ou seja, v1.0.0 publicará 1.0.0 ).

Este formato pode ser personalizado, consulte os documentos de verificação de poesia-dinâmicos

Comandos para desenvolvimento

Todos os comandos comuns usados ​​durante o desenvolvimento podem ser executados usando os alvos Make:

• make dev-dependencies : instalar requisitos de dev
• make update-dependencies : Atualizar requisitos de desenvolvimento
• make fix : Execute o estilo de código e as correções automáticas (sempre que possível)
• make test : Execute o conjunto de testes contra a versão do System Python
• make check : Execute testes contra todas as versões Python disponíveis, estilo de código e verificações de fiapos
• make type , make format , make lint , make bandit : execute a verificação relevante
• make docs : renderize o site MKDOCS localmente