En las entradas anteriores de esta serie hemos visto cómo crear un paquete Python a partir de las plantillas que ofrece Cookiecutter. Una vez hecho esto creamos pruebas, gestionamos las dependencias y documentamos el paquete. Al terminar es necesarios distribuirlo. Quizás el método más conocido para la distribución de paquetes de Python es mediante PyPi, aunque no es el único. También es posible distribuirlo como un archivo comprimido o desde un repositorio Git, como pude ser el caso de GitHub o Bitbucket. En esta entrada final vamos a ver cómo distribuir los paquetes de Python.
Esta entrada forma parte de la colección “Creación de paquetes de Python” que consta de las siguientes siete entradas:
- Creación de paquetes de Python
- Pruebas unitarias en Python
- Probar en múltiples versiones de Python
- Cobertura de las pruebas unitarias en Python
- Gestionar las dependencias de paquetes Python
- Documentar paquetes de Python
- Distribuir paquetes de Python
Tabla de contenidos
Creación de un archivo comprimido
El método más sencillo para distribuir nuestro paquete es crear un archivo comprimido. Además, PyPI require que se cree un archivo comprimido antes de poder subir un paquete. Algo que se hace comprimiendo la carpeta, sino que usando el archivo setup.py. Para lo que solamente nos tenemos que situar en la carpeta del proyecto y escribir
python setup.py sdist
lo que creará un archivo comprimido en la carpeta dist. Por defecto en sistemas Unix se creará un archivo tar.gz, mientras que en Windows el formato será zip. En caso de que deseemos otro formato se lo podemos indicar mediante la propiedad --formats. Incluso más de uno, como el siguiente ejemplo con el que se genere tanto gztar como zip:
python setup.py sdist --formats=gztar,zip
Los archivos creados tendrán en nombre del paquete seguido del número de versión.
Instalación de los archivos comprimidos
Una vez generados los archivos comprimidos los podemos distribuir por cualquier medio habitual. La instalación también se realiza con pip, pero en lugar del nombre del paquete hay que indicar la ruta relativa o absoluta al archivo. Por ejemplo, si nos encontramos en la carpeta que contiene el paquete comprimido se puede instalar con
pip install ./pylan-0.1.0.tar.gz
Lo que ejecutara el proceso de instalación como si se hubiese bajado el paquete desde PyPi.
Distribución de paquetes de Python mediante Git
Hoy en día es habitual instalar los paquetes en repositorios Git, tanto públicos como privados. Esta es otra alternativa para que los usuarios puedan instalar los paquetes. El comando pip permite instalar directamente desde un repositorio Git indicando la ruta al repositorio, por ejemplo para un repositorio de GitHub
pip install git+https://github.com/user/repository.git
donde user se tiene que reemplazar por el nombre del usuario y repository por el nombre del repositorio. También se puede instalar directamente desde los archivos zip que se pueden descargar GitHub indicando la ruta a este:
pip install https://github.com/user/repository/archive/branch.zip
Este proceso también se puede utilizar si el repositorio se encuentra en otro servicio o en un servidor privado.
Distribución mediante PyPI
PyPI es el lugar donde se encuentran la mayoría de los paquetes de Python, por lo que si nuestro paquete es libre lo podemos distribuir a través de este servicio. Para distribuir paquetes mediante PyPI es necesario crear una cuenta en el servicio. Siendo aconsejable crear una cuenta primero en PyPI test para donde es posible realizar pruebas antes de subir nuestros paquetes.
Configuración en nuestro ordenador
Una vez se ha creado la cuenta de usuario es necesario crear un archivo, llamado .pypirc y ubicado en la carpeta raíz del usuario, en el que se guardarán las credenciales de la cuenta. Básicamente este archivo ha de tener la siguiente información
[distutils] index-servers = pypi [pypi] username=your_username password=your_password
donde your_username es el nombre del usuario y your_password la contraseña.
Instalación de twine
Para subir los paquetes es necesario tener instalado el paquete twine, el cual se puede instalar con pip:
pip install twine
Subida del paquete a los servidores de PyPI
Una vez instalado twine y configurada la cuenta se puede subir el paquete se pude subir el archivo comprimido con el paquete. Para lo cual es necesario seguir los pasos que se indicaron al principio de la entrada. Es aconsejable subirlo en primer lugar a la cuenta de prueba, para lo que usaremos la siguiente expresión
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Punto en el que se pedirá el usuario y la contraseña del servicio pruebas. Una vez subido el paquete se pude comprobar si este se instala correctamente con el comando
pip install --index-url https://test.pypi.org/simple/ pylane
en donde reemplazamos pylane por el nombre de nuestro paquete. En caso de que todo sea correcto se puede subir el paquete a PyPI con el siguiente comando.
twine upload dist/*
Publicando ya el paquete en PyPI.
Conclusiones
En esta última entrada de la serie “Creación de paquetes de Python” se ha visto cómo realizar la distribución de paquetes de Python. Un proceso que varía en función de a quienes sean nuestros usuarios. Si los paquetes no son públicos la mejor opción es mediante archivo comprimido o un repositorio Git privado. Por otro lado, si son públicos los podemos subir a PyPI o dejarlos en GitHub.
El código utilizado en esta serie se puede encontrar en un repositorio de la cuenta de GitHub de Analytics Lane.
Deja una respuesta