usuariobkp / cookiecutter-pypackage-ar

Cookiecutter template para paquetes de Python del equipo de Datos Argentina.

Cookiecutter PyPackage - Datos Argentina

Cookiecutter template para paquetes de Python del equipo de Datos Argentina.

Nota: Todavía deben adaptarse/traducirse varias partes y eliminar algunas cosas que no usamos.

Esto es un fork del audrey/cookiecutter-pypackage que estamos adaptando y traduciendo para uso de los nuevos repositorios pythonicos del equipo de Datos.

Indice

• Features
• Instalación
• Uso
• Release checklist
• Otros cookiecutter templates
• Créditos
• Contacto

Features

• Travis-CI: Preparado para integración continua con Travis CI.
• Documentación automática: Documentación preparada para generarse y publicarse en ReadTheDocs.
• Auto-release a PyPI: Cada vez que se hace un tag con una nueva versión, se publica en PyPi automáticamente.

Instalación

Instalar la última versión de Cookiecutter (este template requiere Cookiecutter 1.4.0 o mayor)::

pip install -U cookiecutter

Uso

1. Crear un repositorio en Github y clonarlo localmente
2. Seguir todos los pasos para crear un repositorio usando el template de cookiecutter: cookiecutter https://github.com/datosgobar/cookiecutter-pypackage-ar.git. Mover todo el contenido a la carpeta del repo clonado.
3. pip install -r requirements_dev.txt para instalar las dependencias de desarrollo (se recomienda crear un entorno virtual para el proyecto primero)
4. Ir a tu cuenta de Travis CI y agregar el nuevo repo (switch on)
   • Modificar el archivo .travis.yml eliminando aquellas versiones de python no soportadas y agregando aquellas que sí lo sean
5. Agregar el repo a tu cuenta de ReadTheDocs y switch on para activar el servicio.

• make docs para crear la documentación localmente, luego pushear para que vaya a Read The Docs.

1. make pypi para registrar el repo en Pip y activar el auto-deploy con tags en Travis CI (requiere una cuenta en PyPi).
   • Esta acción genera el primer release a pypi.

Para más detalles ver cookiecutter-pypackage tutorial.

Release checklist

Antes de cada nuevo release a PyPi, deben seguirse estos pasos:

0. Chequear que todos los tests corran OK
1. Cambiar la versión en el setup.py
2. Cambiar la versión en el __init__.py del paquete
3. Agregar una nueva entrada al HISTORY.md bulleteando brevemente las diferencias que tiene el nuevo release respecto del anterior, para el usuario del paquete
   • Recordar cambiar la versión
   • Recordar cambiar la fecha
4. Correr make docs en el root del repo antes de pushear
5. Commitear y pushear
6. Taggear el commit con la versión del nuevo release

Otros cookiecutter templates

Ver repositorio de audrey/cookiecutter-pypackage para otros templates de repos en python o directamente el de audreyr/cookiecutter para una lista de templates de todo tipo.

Créditos

• @audrey por su fantástico ultimate template para un repositorio modelo en Python audrey/cookiecutter-pypackage.

Contacto

Te invitamos a crearnos un issue en caso de que encuentres algún bug o tengas feedback de alguna parte de cookiecutter-pypackage-ar.

Para todo lo demás, podés mandarnos tu comentario o consulta a [email protected].