template package importable

Descripción general

Esta es la plantilla del paquete que usamos internamente al crear nuevos paquetes importables basados ​​en Python. Tiene toda la funcionalidad básica y los flujos de trabajo necesarios para crear, construir y publicar un nuevo paquete para PYPI.

Esta plantilla de paquete no proporciona ninguna funcionalidad CLI, sino que está diseñada para crear paquetes importables.

Decidimos poner esto a disposición junto con nuestras otras herramientas para permitir que las personas usen un punto de partida bien diseñado al crear sus propias herramientas.

También proporcionamos otras 2 plantillas que utilizamos.

• Proyecto Python de plantilla
• paquete de plantilla CLI

Características

• Arquitectura modular : organice su código en módulos para una mejor capacidad de mantenimiento.
• Excepciones personalizadas : ejemplos básicos para implementar excepciones personalizadas para un manejo de errores específicos.
• Ejemplos de pruebas : Ejemplos básicos para escribir pruebas de Pytest para su paquete.

Instalación

Para instalar el paquete importable, clone el repositorio y navegue al directorio del proyecto:

git clone https://github.com/DevelopersToolbox/template-package-importable.git
cd template-package-importable

Se recomienda utilizar un entorno virtual para administrar las dependencias. Puede crear y activar un entorno virtual utilizando los siguientes comandos:

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

Instale las dependencias requeridas:

pip install -r requirements.txt

Estructura de proyectos

El proyecto está organizado de la siguiente manera:

template-package-importable/
├── wolfsoftware/
│   └── template_package_importable/
│       ├── __init__.py
│       ├── exceptions.py
│       └── functions.py
├── tests/
│   ├── __init__.py
│   └── test_template_package_importable.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_importable : contiene los módulos principales de la aplicación.
  • exceptions.py : maneja las excepciones personalizadas.
  • functions.py : Define algunas funciones de ejemplo (para pruebas).
• tests : donde se encuentran las pruebas de Pytest.
  • test_template_package_importable.py : las pruebas específicas para ejecutarse.
• setup.py : la configuración del paquete.
• requirements.txt : enumera las dependencias requeridas para el proyecto.
• README.md : el archivo que está leyendo actualmente.