New Empty Python Project Base

Nueva base de proyectos de Python vacío

Esto es justo lo que necesitas para comenzar un nuevo proyecto de Python.

Simplemente use esta plantilla de proyecto para comenzar nuevos proyectos de Python.

Uso de esta plantilla para su proyecto (cómo)

Ahora puede crear automáticamente un nuevo proyecto basado en esta plantilla haciendo clic aquí en Use this template , o haciendo clic en el botón de arriba en el repositorio, como se muestra en la imagen a continuación. Si no usa GitHub, también puede simplemente clonar este repositorio.

Adaptarlo para su propio proyecto

1. Cambie el nombre del project/ carpeta (y todas las referencias a esta carpeta en otros archivos) para personalizar el nombre de su proyecto que actualmente se denomina project según el nombre de la carpeta.
2. Puede ejecutar pruebas ejecutando pytest en la raíz o ejecutando python3 setup.py test . La cobertura del código está habilitada con Pytest-Cov.
3. Edite el setup.py de su proyecto para que sea realmente suyo. Elimine mi correo electrónico e información de aquí y coloque su propia información. También puede eliminar el archivo setup.py completo en lugar de adaptarlo si no tiene la intención de publicar su proyecto en pip ni en conda como un paquete.
4. ¡Comience a codificar en su carpeta de proyecto ahora renombrada y agregue algunas pruebas más en la testing/ carpeta!

Si construye un paquete: implementa su nuevo paquete a Pypi

¡Cargue su proyecto como un paquete en Pypi, el índice de paquetes de Python, para que esté disponible en pip ! (opcional)

Para hacer eso, lea mi guía paso a paso de cómo implementar un nuevo paquete (o versión del paquete) a PYPI.

Si construye una aplicación REST API (por ejemplo: SaaS): estructurando las capas de la arquitectura de su software

He grabado aquí mis consejos y trucos, qué buscar y cómo estructurar su aplicación para que esté limpia en términos de arquitectura de software: https://youtu.be/k4qn27ikr0g?t=1211

Comprender cómo funciona esta plantilla

El artículo La estructura óptima del proyecto Python de Luke Tonin hace un buen trabajo al explicar cómo funciona una plantilla como la actual. La plantilla actual es un poco más completa y compleja que en el artículo, pensamiento, ya que ya incluye un conjunto de pruebas (incluido un ejemplo de prueba de inicio) y un archivo setup.py completo para que su proyecto se empaquete correctamente.

También está mi video sobre arquitectura de software que puede ayudar, en el que hago la descripción general de un proyecto completo basado en esta plantilla, en términos de arquitectura teórica de software en lugar de práctico usar la plantilla.

Licencia

En la medida de lo posible según la ley, Guillaume Chevalier y Neuraxio Inc. han renunciado a todos los derechos de autor y derechos relacionados o vecinos sobre este trabajo.

Se agradecerán las citas que vinculan a este repositorio, pero no son necesarias.