Skip to content

Latest commit

 

History

History
268 lines (184 loc) · 9.22 KB

README.es.rst

File metadata and controls

268 lines (184 loc) · 9.22 KB
Raw

⚙️Automatice su publicación a PyPI con PBR y Travis

Para la documentacion completa:

Dirigirse a documentacion

✔️Paso 1: escribir la configuracion de tu proyecto python

Si estas buscando publicar tu proyecto en Pypi, primero tenes que crear el archivo de configuracion

En este tutorial, vamos a realizarlo con el uso de PBR que nos simplificara el proceso.

Setup.py

Como se puede ver en el archivo python setup incluido en este repositorio, la sintaxis es bastante basica.

"""Setup example."""

from setuptools import setup


setup(
    setup_requires=['pbr'],
    pbr=True
)

🎉 Simplemente se define que vas a usar PBR y eso es todo! 🎉

Setup.cfg

Como se puede ver en el archivo config setup incluido en este repositorio, la sintaxis no es mas complicada que este ultimo archivo.

Veamos cada seccion juntos.

Primero de todo, la seccion de metadata:

# Tipo de distribucion de python
[bdist_wheel]
universal=0

[metadata]
# Nombre de la aplicacion
name = Publishing to PyPI with pbr and Travis
# Quien hizo esto?
author = Maël Pedretti
# Es necesario explicar lo siguiente?
author_email = [email protected]
# Una descripcion corta de la aplicacion
summary = Publishing to Pypi with PBR and Travis.
# Tipo de licencia
license = MIT
# Archivo que va a contener una descripcion larga
description-file =
    README.rst
# Donde puedo tener acceso al proyecto?
home-page = https://github.com/73VW/Publishing-to-PyPI-with-pbr-and-Travis
# Que version de python necesito para correr la aplicacion?
python_requires = >=3.6
# Como se clasifica tu aplicacion? https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifier =
    Development Status :: 4 - Beta
    Environment :: Other Environment
    Intended Audience :: Education
    Operating System :: MacOS :: MacOS X
    Operating System :: Microsoft :: Windows
    Operating System :: POSIX
    Programming Language :: Python :: 3 :: Only
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: Implementation :: CPython
    Topic :: Education

# Automaticamente busca el paquete raiz
[options]
packages = find:

# Que archivos no son del codigo fuente que deseas implementar?
[files]
data_files =
    some/example = some/example/*

# Donde empieza la aplicacion?
[entry_points]
console_scripts =
    automabot = your_package.__main__:main

🎉 Despues de algunos ajustes, estamos listos para seguir! 🎉

✔️Paso 2: Habilitar Travis!

Dos formas de habilitar Travis, una usando Travis CLI y otra sin usarlo.

Usando travis CLI

Ejecuta travis login y logueese en travis.

Ahora podes ejecutar travis init.

Si estas en un repositorio git, Travis va a detectar esto y va a preguntar si es correcto.

De lo contrario, te dirá que puede detectar el repositorio.

Una vez presionado Enter, Travis te pregunta el lenguaje principal. En este caso, esribimos Python.

Ahora se creo un archivo llamado .travis.yml y esta disponible en tu repositorio. Travis esta disponible ahora para este repo.

Vamos a volver por este archivo mas tarde.

Manualmente

  • Ir a la página de inicio de Travis home page.
  • Regístrate o Inicia sesión.
  • Ir a tu página de perfil y sincronizar tu cuenta.
  • Tus repositorios públicos de Github ahora están listados arriba.
  • Cambia al proyecto que quieras.

.travis.yml

Ahora vamos a escribir nuestro archivo de configuración.

Como el documento está realmente bien hecho, sugiero que se revise primero, porque no lo voy a explicar todo. Se puede encontrar aca https://docs.travis-ci.com/user/getting-started/.

Sin embargo, voy a explicar la configuración que suelo usar.

# Es necesario explicar esta linea?
language: python

# Se puede usar la cache para realizar el build mas rapido
cache: pip

# version de python. Se pueden definir mas de uno si se quiere realizar multiples pruebas.
python:
  - '3.6'

# su script de instalación o su lista de instalación
install: pip install rstcheck

# tu script de prueba o tu lista de instalación
script: rstcheck --recursive .

# configurando las notificaciones , a mi personalmente no me gusta que me llegue spam a mi email.
notifications:
  email:
    on_failure: never
    on_pull_requests: never

# la parte interesante!
deploy:
  # Si necesita implementar archivos que Travis ha creado, use la siguiente línea
  skip_cleanup: true
  # En caso de que queramos hacer la implementacion a pypi
  provider: pypi
  # Para cuales distribuciones queremos hacer la implementacion
  distributions: sdist bdist_wheel
  # Cuando queremos hacer la implementacion
  on:
    # En este caso solo queremos hacer el deploy cuando el tag este presente...
    tags: true
    # ... y cuando el tag esta sobre la master "v0.0.0"
    branch:
      - master
      - /v?(\d+\.)?(\d+\.)?(\*|\d+)$/
  # Usuario de pypy
  user: 73VW
  # Contrasenia de Pypi password asegurada por Travis si tenes Travis CLI instalado
  password:
    secure: cGJz+vETnxwWAZQvzveJKOyn3rWy3/tcVmJvTVuflrgKgwMRm+sfQZB3vo39LzDcDbMzlzxLO4SUsqDpCxlPPM1pCjqHeUkke76pXA3HGTqfSS5VBic979pBDBqzFe8SLxery0ND7uPAam2xtZQcMRjIzMZFS+ZBD3tD9pWFnFqQOaw6Mwnfj2dWuA7BeNEBEeG+EErAJTqWHlwodjLsDBBilrvYEMPha049JWSz9TE1SMUKWZszCpo2hda8edvcB7WrNWJCYO+Pmc56aUHGlqiyRUowec9ZQplhmD7HWriRvda4n+1WqUB8tdACqBSBo6t39dis/yiLDv/qZpi6cooxJBtlK184AZvCIfjiu8ua5JqJ/SBghzrwLf7b5VbWg/WOtS8NEB+TYhZhpmkYLPXnOoJLYbbrOYA/sz/QfwXke2NCTp7apZFAtU1lFN2gVWsmff7ysRWwwHW/iidCAcu9BXlwMt2x2dv5PqSSqN1QdwCQ+cGcewlIPInHwCpXwI4sJXPEHeax0J5c206Yf4PMkzgrUj1+UmpB2AKJkMF0+kGd+MOj9SXYbNE1Lc456CuvKUflVry12mVQCgqqL6lZQadQ+aNKy0LoK4o4CN6JTUMpIn6JIOapLc9hzOGZgVuFzZ5YAs6l8VraMzZuAzOEv79UB92B3Iq2Vxki8vo=
  # Use the following if you don't have Travis CLI
  password : ${PYPI_PASSWORD}

Contraseña

Si no tenes Travis CLI instalado, use la segunda opcion que yo mencione anteriormente y haga lo siguiente:

  • En tu pagina de perfil, busca tu proyecto y clickea en un pequeño engranaje ⚙️. Esto te llevara a la configuracion.
  • Dirigirse a la seccion Environment Variables y agregar una nueva variable.
  • Si tomaste mi ejemplo, el nombre va a ser PYPI_PASSWORD y el valor de la password.

How-to add your password to Travis

Si tenes Travis CLI, esto es para vos.

  • Dejar la sesion de password en blanco, como lo siguiente.
user: 73VW
# Your Pypi password
password:
  • Vamos a encriptar esto! Simplemente ejecutar travis encrypt --add deploy.password y Travis te va a preguntar el password, va a encriptarlo y lo va a colocar en el archivo.

🎉 Ahora estas listo para seguir adelante! 🎉

✔️Bien, ahora que?!

Bueno, ¡intentemos enviar todo al repositorio para comprobar si todo está bien y si las pruebas pasan!

Vamos a Travis home page y chequeamos que este todo bien!

Como recordarás, no configuramos ningun tag en github, por lo que este commit no se debe implementar.

Travis tambien nos va a decir esto:

Skipping a deployment with the pypi provider because this is not a tagged commit

✔️Vamos a taggear esto!

Ahora, creamos un tag. Esto es muy facil con git, la documentacion puede encontarse aca.

Tener en cuenta que con git tag la opcion -a te permite especificar la version y -m el mensaje.

Entonces el comando deberia ser el siguiente:

git tag -a 0.0.1 -m "Primer implementacion pypi"

Ahora se puede chequear si este fue creado corriendo git tag. El resultado deberia parecerse a lo siguiente:

$ git tag
v0.0.1

Ahora vamos a realizar un push y chequear nuevamente que Travis, Pypy y tu paquete deberian ser implementados.

Observacion : No olvidarse de agregar --tags para realizar el push, sino esto solo quedara en tu repositorio local.

✔️Implementando!

⚠️Notas globales

✔️ Tu proyecto debe ser público para poder utilizar Travis. De lo contrario teenes que actualizar a Travis pro.

✔️ Tu dirección de correo electrónico debe ser verificada en Pypi para poder cargar un nuevo proyecto. De lo contrario se rechazará la subida.

✔️ Tu versión de etiqueta DEBE tener el formato [DIGITO.DIGITO.DIGITO]. Consulte https://docs.openstack.org/pbr/3.1.0/semver.html para obtener más información.