Pasos para Crear y Publicar un Paquete de Python

1️⃣ Crear el archivo setup.py

El archivo setup.py es fundamental para definir la información y la estructura de tu paquete. Crea un archivo llamado setup.py en la raíz de tu proyecto con el siguiente contenido:

from setuptools import setup, find_packages

setup(
    name="mi_paquete",                            # Nombre del paquete
    version="0.0.1",                             # Versión inicial
    packages=find_packages(),                     # Paquetes a incluir
    description="Un paquete pip simple de saludo",  # Breve descripción
    author="Tu Nombre",                           # Tu nombre
    author_email="tu_email@example.com",         # Tu correo electrónico
    url="https://github.com/tu_usuario/mi_repositorio",  # URL del proyecto
)

2️⃣ Crear la estructura de carpetas

Crea una carpeta con el mismo nombre que tu paquete. Dentro de esta carpeta, crea un archivo llamado __init__.py que será el módulo principal de tu paquete. La estructura de tu proyecto debería verse así:

mi_proyecto/
│
├── setup.py
└── mi_paquete/
    ├── __init__.py

3️⃣ Agregar contenido al archivo __init__.py

Dentro del archivo __init__.py, puedes definir las funciones o clases que desees que tu paquete exponga. Por ejemplo:

def saludar(nombre):
    return "Hola " + nombre + ", este es mi primer paquete pip!"

4️⃣ Crear el paquete

Abre tu terminal, navega a la raíz de tu proyecto y ejecuta el siguiente comando para crear el paquete:

python3 setup.py bdist_wheel sdist

Esto generará archivos .whl y .tar.gz en una carpeta llamada dist, que contienen tu paquete listo para ser distribuido.

5️⃣ Crear un nuevo Release en GitHub

1. Ve a tu repositorio en GitHub.
2. Haz clic en la pestaña "Releases".
3. Haz clic en "Draft a new release".

6️⃣ Crear un Tag (Versión)

En la sección "Tag version", escribe la versión de tu paquete, por ejemplo, v0.0.1. Asegúrate de que el tag siga el formato vX.Y.Z, donde X, Y, y Z son números que representan la versión.

7️⃣ Publicar el Release

1. Sube los archivos que generaste en la carpeta dist a este nuevo release. Puedes arrastrarlos y soltarlos en la interfaz de GitHub.
2. Escribe una descripción del release si lo deseas.
3. Haz clic en "Publish release" para hacer público tu paquete.

8️⃣ Instalar el paquete usando pip

Una vez que hayas publicado tu paquete, otros usuarios podrán instalarlo usando pip directamente desde tu repositorio de GitHub:

pip install git+https://github.com/tu_usuario/mi_repositorio.git

Consideraciones Finales

• Pruebas: Antes de publicar tu paquete, asegúrate de probarlo localmente para verificar que todo funcione como se espera.
• Documentación: Es recomendable incluir documentación sobre cómo usar tu paquete, ya sea en el README del repositorio o en un archivo separado.
• Versionado: Sigue buenas prácticas de versionado (semántico) para facilitar el mantenimiento y la actualización de tu paquete.

Con estos pasos, habrás creado y publicado con éxito un paquete de Python en GitHub. ¡Buena suerte!