cookiecutter hatch pypackage

cookiecutter hatch pypackage

Plantilla Cookiecutter para un paquete Python de última generación: Hatch , ruff , mypy , GitHub Actions y más.

Detalles
Características

Características

• Arrancador ligero
• Gestión de paquetes Hatch
• hatch-vcs: determina la versión del paquete automáticamente a partir de etiquetas git, por ejemplo, v0.9
• Linting y formateo con ruff que sustituye a isort, flake8, black, etc.
• Comprobación de tipos con mypy
• Verifique las dependencias no utilizadas, faltantes y transitivas con deptry
• Pruebas unitarias con pytest con configuración asyncio opcional.
• Automatice y estandarice las pruebas con Hatch-env-matrices
• Documentación con Material para MkDocs y soporte de referencia de cadenas de documentos con mkdocstrings.
• Canalizaciones de GitHub Actions listas para usar con dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows y más.
• hatch-pip-compile: soporte experimental para archivos de bloqueo,
• pyproject.toml: todo el paquete, compilación y configuración de herramientas en un solo archivo,
• cobertura: herramienta para medir la cobertura de código de programas Python con integración pytest,
• compromiso previo: ganchos de git de compromiso previo que le hacen la vida más fácil,
• Markdown: en lugar de reStructuredText, Markdown se utiliza de forma coherente para todos los archivos de texto.
• EditorConfig: mantiene estilos de codificación consistentes para múltiples desarrolladores,
• src-layout: el paquete Python real se guarda en una carpeta src evitando muchos errores comunes.

? Inicio rápido

Generar el proyecto:

Este proyecto utilizará pipx para instalar hatch en un entorno aislado. Asegúrese de tener pipx instalado antes de ejecutar el siguiente comando.

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

El generador llamará automáticamente hatch env create & git init al final.

Luego, para que las GitHub Actions pipelines funcionen correctamente, debes:

• Habilite el repositorio de GitHub en Codecov .
• Establece CODECOV_TOKEN en los secretos de tu repositorio de GitHub. Puede encontrarlo en la configuración de Codecov del proyecto correspondiente.
• Habilite GitHub Pages usando la fuente de GitHub Actions .
• Opción de publicar en Test PyPI para realizar pruebas.
• Configure el método Trusted Publisher en PyPI: es un método moderno y seguro para enviar su paquete a PyPI.

con crujido

cruft es una capa encima de Cookiecutter que le permite actualizar su proyecto desde la plantilla una vez generado.

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

Manifestación

Licencia

Este proyecto está autorizado según los términos de la licencia MIT.