cookiecutter hatch pypackage

cookiecutter hatch pypackage

Modèle Cookiecutter pour un package Python de pointe : Hatch , ruff , mypy , GitHub Actions et plus encore !

Détails
Caractéristiques

Caractéristiques

• Démarreur léger
• Gestion des paquets Hatch
• Hatch-vcs : détermine automatiquement la version du package à partir des balises git, par exemple v0.9
• Peluchage et mise en forme avec ruff qui remplace isort, flake8, black, etc.
• Vérification de type avec mypy
• Vérifiez les dépendances inutilisées, manquantes et transitives avec deptry
• Tests unitaires avec pytest avec configuration asyncio facultative.
• Automatisez et standardisez les tests avec les matrices Hatch-env
• Documentation avec Material for MkDocs et prise en charge de la référence docstring avec mkdocstrings.
• Pipelines GitHub Actions prêts à l'emploi avec dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows et plus encore.
• Hatch-pip-compile : support expérimental des fichiers de verrouillage,
• pyproject.toml : toute la configuration des packages, des builds et des outils dans un seul fichier,
• couverture : outil de mesure de la couverture du code des programmes Python avec intégration pytest,
• pre-commit : des hooks git pré-commit qui vous facilitent la vie,
• Markdown : au lieu de reStructuredText, Markdown est utilisé de manière cohérente pour tous les fichiers texte,
• EditorConfig : maintenir des styles de codage cohérents pour plusieurs développeurs,
• src-layout : le package Python actuel est conservé dans un dossier src évitant ainsi de nombreuses erreurs courantes.

? Démarrage rapide

Générez le projet :

Ce projet utilisera pipx pour installer hatch dans un environnement isolé. Assurez-vous que pipx est installé avant d'exécuter la commande suivante.

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

Le générateur appellera automatiquement hatch env create & git init à la fin.

Ensuite, pour que les GitHub Actions pipelines fonctionnent correctement, vous devez :

• Activez le référentiel GitHub dans Codecov .
• Définissez CODECOV_TOKEN dans les secrets de votre référentiel GitHub. Vous pouvez le trouver dans les paramètres Codecov du projet correspondant.
• Activez GitHub Pages à l’aide de la source GitHub Actions .
• Option de publication sur Test PyPI pour les tests.
• Configurez la méthode Trusted Publisher sur PyPI : c'est une méthode moderne et sécurisée pour pousser votre package vers PyPI.

Avec de la cruauté

cruft est une couche au-dessus de Cookiecutter vous permettant de mettre à jour votre projet à partir du modèle après sa génération.

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

Démo

Licence

Ce projet est sous licence selon les termes de la licence MIT.