Cómo crear un paquete de Python y publicarlo

La creación y publicación de un paquete de Python le permite compartir su código con la comunidad de Python en general. En esta guía, le explicaremos los pasos para crear un paquete de Python y publicarlo en el índice de paquetes de Python (PyPI), donde otros usuarios pueden instalarlo y usarlo fácilmente.

Configuración de su proyecto

Antes de comenzar, asegúrese de tener Python instalado en su sistema. También deberá instalar los paquetes setuptools y wheel si aún no lo ha hecho:

pip install setuptools wheel

Creando la estructura del paquete

Cree un nuevo directorio para su proyecto de paquete. Dentro de este directorio, cree la siguiente estructura:

your_package/
    your_package/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
    setup.py
    README.md
    LICENSE

A continuación se muestra una breve descripción general de estos archivos:

• your_package/__init__.py: marca el directorio como un paquete de Python.
• your_package/module1.py y your_package/module2.py: Los módulos de su paquete.
• tests/: Directorio para los casos de prueba de su paquete.
• setup.py: El script de compilación para su paquete.
• README.md: Un archivo que explica lo que hace su paquete.
• LICENCIA: El archivo de licencia de su paquete.

Cómo escribir el script de configuración

El archivo setup.py es esencial para definir los metadatos y las dependencias del paquete. A continuación, se muestra un ejemplo básico:

from setuptools import setup, find_packages

setup(
    name='your_package',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # List your package dependencies here
    ],
    description='A brief description of your package',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/your_package',
    author='Your Name',
    author_email='your.email@example.com',
    license='MIT',
)

Creación de un archivo README

El archivo README.md debería proporcionar una descripción general del paquete, incluido cómo instalarlo y usarlo. A continuación, se incluye un ejemplo:

# Your Package

A brief description of your package.

Instalación

pip install your_package

Uso

import your_package

# Example usage

Construyendo el paquete

Navegue al directorio de su proyecto y ejecute el siguiente comando para compilar su paquete:

python setup.py sdist bdist_wheel

Este comando crea archivos de distribución en el directorio dist/.

Publicación en PyPI

Para publicar tu paquete, necesitas una cuenta en PyPI. Si no tienes una, créala en PyPI.

A continuación, instale el paquete twine:

pip install twine

Utilice twine para cargar su paquete a PyPI:

twine upload dist/*

Se le solicitará su nombre de usuario y contraseña de PyPI. Después de una carga exitosa, su paquete estará disponible en PyPI.

Conclusión

¡Felicitaciones! Ya ha creado y publicado su paquete Python. Otros usuarios pueden instalarlo usando pip, y usted puede continuar actualizándolo y mejorándolo. Recuerde mantener su paquete actualizando el número de versión y cargando nuevas versiones a medida que realiza cambios.