cookiecutter hatch pypackage

cookiecutter hatch pypackage

Modelo Cookiecutter para um pacote Python de última geração: Hatch , ruff , mypy , GitHub Actions e muito mais!

Detalhes
Características

Características

• Iniciante leve
• Gerenciamento de pacotes Hatch
• hatch-vcs: determina a versão do pacote automaticamente a partir de tags git, por exemplo, v0.9
• Linting e formatação com ruff que substitui isort, flake8, black, etc.
• Verificação de tipo com mypy
• Verifique dependências não utilizadas, ausentes e transitivas com deptry
• Testes de unidade com pytest com configuração assíncrona opcional.
• Automatize e padronize testes com matrizes Hatch-env
• Documentação com Material para MkDocs e suporte de referência de docstring com mkdocstrings.
• Pipelines GitHub Actions prontos para usar com dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows e muito mais.
• hatch-pip-compile: suporte experimental para arquivos de bloqueio,
• pyproject.toml: todas as configurações de pacotes, construções e ferramentas em um arquivo,
• cobertura: ferramenta para medir a cobertura de código de programas Python com integração pytest,
• pré-commit: ganchos git pré-commit que tornam sua vida mais fácil,
• Markdown: em vez de reStructuredText, Markdown é usado consistentemente para todos os arquivos de texto,
• EditorConfig: mantenha estilos de codificação consistentes para vários desenvolvedores,
• src-layout: o pacote Python real é mantido em uma pasta src evitando muitos erros comuns.

? Início rápido

Gere o projeto:

Este projeto utilizará pipx para instalar hatch em um ambiente isolado. Certifique-se de ter pipx instalado antes de executar o seguinte comando.

cookiecutter https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

O gerador chamará automaticamente hatch env create & git init no final.

Então, para que os GitHub Actions pipelines funcionem corretamente, você deve:

• Habilite o repositório GitHub no Codecov .
• Defina CODECOV_TOKEN nos segredos do seu repositório GitHub. Você pode encontrá-lo nas configurações do Codecov do projeto correspondente.
• Habilite GitHub Pages usando a fonte GitHub Actions .
• Opção de publicar no Test PyPI para teste.
• Configure o método Trusted Publisher no PyPI: é um método moderno e seguro para enviar seu pacote para o PyPI.

Com lixo

cruft é uma camada acima do Cookiecutter que permite atualizar seu projeto a partir do modelo após ele ter sido gerado.

cruft create https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

Demonstração

Licença

Este projeto está licenciado sob os termos da licença do MIT.