bootstrap python package

paquete de bootstrap-python

Este repositorio de plantillas proporciona la Boilerplate para crear un paquete Python. Está configurado con las siguientes características:

• Test Suite con Tox y Pytest
• Escribiendo usando mypy
• Formato de pelusa, seguridad y código utilizando Ruff (utilizando el estilo de código negro y las reglas de seguridad de los bandidos)
• Integración con CodeClimate para la calidad del código y las verificaciones de cobertura
• Soporte de tuberías CI:
  • Prueba contra múltiples versiones de Python
  • Lanzamientos en PYPI
  • Documentación de las páginas de Github utilizando MKDOCS
• Configuración básica del perfil de Pycharm

Cómo usar esta plantilla de repositorio para crear un nuevo paquete

• Cree su repositorio de GitHub usando esta plantilla. (El gran verde Use this template )
• Cambiar el nombre del directorio bootstrap_python_package
• Busque y reemplace todas las ocurrencias de bootstrap-python-package y bootstrap_python_package
• Configure un editor de confianza pendiente en PYPI utilizando los siguientes valores:
  • Nombre del proyecto Pypi: el nombre del repositorio de GitHub (en este caso bootstrap-python-package )
  • Propietario: El propietario del repositorio de GitHub (en este caso febus982 )
  • Nombre del repositorio: el nombre del repositorio de GitHub (en este caso bootstrap-python-package )
  • Nombre del flujo de trabajo: release.yml
• Create a GitHub Actions secret named CODECLIMATE_REPORTER_ID (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ) containing the codeclimate reporter id (you can find it at https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ). Si no desea usar CodeClimate, simplemente elimine workflows/python-quality.yml .
• ¡Actualice las insignias en README.md ! (Verifique Shields.io en busca de insignias adicionales)
• Actualice el perfil de copyright pycharm en la configuración IDE: Editor | Copyright | Perfiles de derechos de autor (si quieres usarlo)
• Configuración del desarrollo local:
  • Clonar el repositorio
  • Instalar poesía pip install poetry
  • Instale las dependencias de devoluciones con make dev-dependencies
  • (Opcional) Se recomienda instalar la instalación previa al compromiso y ejecutar pre-commit install para que el formato y la pelusa se ejecuten automáticamente durante git commit .
• Configuración de páginas GitHub (esta necesidad de configuración de desarrollo local):
  • Inicialize Documentation Branch poetry run mike deploy dev latest --update-aliases --push
  • Configure las páginas de GitHub para implementar desde la rama gh-pages (en URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • Agregue la rama main y la v*.*.* Las reglas de la etiqueta a la lista de "ramas y etiquetas de implementación" en el entorno gh-pages (en URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments )

IMPORTANTE: El repositorio está configurado para implementar en el repositorio de prueba PYPI. Se recomienda encarecidamente crear el proyecto en el repositorio PYPI de prueba y probar la tubería de implementación. Cuando esté satisfecho con el resultado, cree el proyecto en el repositorio oficial de PYPI y elimine las líneas marcadas en workflows/release.yml .

Lanzamiento del paquete

Esta configuración utiliza poesía-dinámica-versioning. Esto significa que no es necesario confirmar la versión en el código, pero la tubería CI lo inferirá de la etiqueta GIT.

Para lanzar una nueva versión, simplemente cree una nueva versión y etiqueta en el repositorio de GitHub, a:

• Construya e implementa el paquete Python en Pypi
• Construya e implementa una nueva versión de la documentación a las páginas de Github

IMPORTANTE: La configuración predeterminada requiere el nombre de versión y la etiqueta para seguir la convención vX.XX (versiones semánticas precedidas por minucasos v ). Publicará la versión correcta en PYPI, omitiendo la v (es decir, v1.0.0 publicará 1.0.0 ).

Este formato se puede personalizar, consulte la poesía-dinámica-dinámica de los documentos

Comandos para el desarrollo

Todos los comandos comunes utilizados durante el desarrollo se pueden ejecutar utilizando objetivos de marca:

• make dev-dependencies : instalar los requisitos de desarrollo
• make update-dependencies : actualizar los requisitos de desarrollo
• make fix : Ejecutar el estilo del código y las correcciones automáticas de pelusa (siempre que sea posible)
• make test : ejecute el suite de prueba contra el sistema Python Version
• make check : Ejecutar pruebas en todas las versiones de Python disponibles, estilo de código y cheques de pelusa
• make type , make format , make lint , make bandit : ejecute el cheque relevante
• make docs : representar el sitio web de MkDocs localmente