bootstrap python package

bootstrap-python-package

Ce référentiel de modèle fournit la baillon pour créer un package Python. Il est configuré avec toutes les fonctionnalités suivantes:

• Test Suite en utilisant Tox et Pytest
• Typing à l'aide de mypy
• Format de liaison, de sécurité et de code à l'aide de RUFF (en utilisant le style de code noir et les règles de sécurité bandit)
• Intégration avec codeclimate pour la qualité du code et les vérifications de la couverture
• Soutien du pipeline CI:
  • Test contre plusieurs versions Python
  • Sormes sur PYPI
  • Documentation des pages GitHub utilisant MKDOCS
• Configuration de base du profil PyCharm

Comment utiliser ce modèle de référentiel pour créer un nouveau package

• Créez votre référentiel GitHub à l'aide de ce modèle. (Le gros vert Use this template )
• Renommer le répertoire bootstrap_python_package
• Recherchez et remplacez toutes les occurrences de bootstrap-python-package et bootstrap_python_package
• Configurez un éditeur de confiance en attente sur PYPI en utilisant les valeurs suivantes:
  • Nom du projet PYPI: le nom du référentiel GitHub (dans ce cas bootstrap-python-package )
  • Propriétaire: le propriétaire du référentiel Github (dans ce cas febus982 )
  • Nom du référentiel: le nom du référentiel GitHub (dans ce cas bootstrap-python-package )
  • Nom du flux de travail: release.yml
• Créer un secret de GitHub Secret nommé CODECLIMATE_REPORTER_ID (sur URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ) contenant l'ID de reporter codeclimate (vous pouvez le trouver chez https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ). Si vous ne souhaitez pas utiliser CodeClimate, supprimez simplement workflows/python-quality.yml .
• Mettez à jour les badges dans README.md ! (Vérifiez Shields.io pour des badges supplémentaires)
• Mettez à jour le profil PyCharm Copyright dans les paramètres IDE: éditeur | Copyright | Profils de copyright (si vous souhaitez l'utiliser)
• Configuration du développement local:
  • Cloner le référentiel
  • Installer la poésie pip install poetry
  • Installez les dépendances de développement avec make dev-dependencies
  • (Facultatif) Il est fortement recommandé d'installer pré-engagement et d'exécuter pre-commit install afin que le formatage et la liaison soient automatiquement exécutés pendant git commit .
• Configuration des pages GitHub (ce besoin de configuration de développement local):
  • Initialiser la documentation Branche poetry run mike deploy dev latest --update-aliases --push
  • Configurez les pages GitHub à déployer à partir de la branche gh-pages (sur URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • Ajoutez la branche main et le v*.*.* TAG Règles à la liste des "branches et tags de déploiement" dans l'environnement gh-pages (sur URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments )

IMPORTANT: Le référentiel est configuré pour déployer sur le référentiel PYPI de test. Il est fortement recommandé de créer le projet dans le référentiel PYPI de test et de tester le pipeline de déploiement. Lorsque vous êtes satisfait du résultat, créez le projet sur le référentiel officiel PYPI et supprimez les lignes marquées dans workflows/release.yml .

Version du package

Cette configuration utilise la poésie-vision de la poésie. Cela signifie qu'il n'est pas nécessaire de commettre la version dans le code, mais le pipeline CI le déduira à partir de la balise GIT.

Pour publier une nouvelle version, créez simplement une nouvelle version et une nouvelle balise dans le référentiel GitHub, vers:

• Créer et déployer le package Python sur PYPI
• Créer et déployer une nouvelle version de la documentation sur les pages GitHub

IMPORTANT: La configuration par défaut nécessite le nom de version et la balise pour suivre la convention vX.XX (version sémantique précédée de minuscules v ). Il publiera la version correcte sur PYPI, omettant le v (c.-à-d. v1.0.0 publiera 1.0.0 ).

Ce format peut être personnalisé, reportez-vous aux documents de la poésie-dynamique

Commandes de développement

Toutes les commandes communes utilisées pendant le développement peuvent être exécutées en utilisant des cibles:

• make dev-dependencies : installer les exigences de développement
• make update-dependencies : mettre à jour les exigences de développement
• make fix : exécutez le style de code et les correctifs automatiques de peluches (si possible)
• make test : exécutez la suite de test contre la version System Python
• make check : exécutez les tests par rapport à toutes les versions Python disponibles, le style de code et les chèques de peluches
• make type , make format , make lint , make bandit : exécuter le chèque pertinent
• make docs : rendre localement le site Web de MKDOCS