Guía de paquetes de Python de pyOpenSci

Apoyamos las herramientas de Python que la comunidad científica necesita para crear flujos de trabajo de ciencia abierta.

Sobre esta guía

Esta guía te ayudará a:

1. Aprender cómo crear un paquete de Python de principio a fin

2. Entender el ecosistema de herramientas de empaquetado de Python

3. Navegar y tomar decisiones sobre las opciones de las herramientas

4. Comprender todos los aspectos de la creación y el mantenimiento de un paquete de Python

También encontrarás recomendaciones de buenas prácticas y listas de recursos de la comunidad seleccionados sobre el empaquetado y la documentación de paquetes.

Serie de tutoriales: Crea un paquete de Python

¡Ya está completa la primera serie de tutoriales sobre cómo crear un paquete de Python para la comunidad científica, desarrollada por nuestra comunidad! Participa en nuestro proceso de revisión comunitaria o sigue el desarrollo de futuros tutoriales en nuestro repositorio de GitHub.

✿ Tutoriales para crear un paquete ✿

• ¿Qué es un paquete de Python?

• Crea un paquete de Python

• Publica tu paquete en (test) PyPI

• Publica tu paquete en conda-forge

✿ Tutoriales sobre metadatos de paquetes ✿

• Cómo añadir un archivo README

• Cómo añadir metadatos a un archivo pyproject.toml para publicar en PyPI.

✿ Tutoriales sobre herramientas de empaquetado ✿

• Introducción a Hatch

• Ejecuta scripts de Python con Hatch

✿ Guías de referencia ✿

• Guía de referencia de la línea de comandos

Paquetes Python para Científicos

Aprende sobre las mejores prácticas de empaquetado de Python. También conocerás el vibrante ecosistema de herramientas de empaquetado que están disponibles para ayudarte con tus necesidades de empaquetado de Python.

✨ Crea tu paquete ✨

• Estructura de archivos de un paquete

• Metadatos del paquete / pyproject.toml

• Construye tu paquete.

• Declara las dependencias

• Oriéntate en el ecosistema de herramientas de empaquetado

• Compilación de paquetes que no están escritos exclusivamente en Python

✨ Publica tu paquete ✨

Comprende mejor el ecosistema de empaquetado de Python. Aprende buenas prácticas para:

• Versionado y lanzamiento de paquetes

• Publica en PyPI y conda-forge

Documentación

✨ Escribe la documentación ✨

• Crea documentación para tus usuarios

• Archivos esenciales que debes incluir en el repositorio de tu paquete

• Escribe tutoriales para mostrar cómo se usa tu paquete

✨ Documentación para desarrolladores ✨

• Crea documentación para los desarrolladores que colaboran en el proyecto

• Escribe una guía de desarrollo

✨ Documentación para la comunidad ✨

• Escribe un archivo README

• Establece normas con un código de conducta

• Asigna una licencia a tu paquete

✨ Publica tu documentación ✨

• Cómo publicar tu documentación

• Usando Sphinx

• Markdown, MyST y ReST

• Publica tu documentación en Read the Docs o GitHub Pages

Pruebas

✨ Pruebas para tu paquete de Python ✨

• Introducción a las pruebas

• Escribe pruebas

• Tipos de pruebas

✨ Ejecuta tus pruebas ✨

• Ejecuta las pruebas localmente con Hatch

• Ejecuta las pruebas con nox

• Ejecuta las pruebas en integración continua (CI)

Contribuir

✨ Estilo y formato del código ✨

• Estilo del código

✨ ¿Quieres contribuir? ✨

Agradecemos las contribuciones a esta guía. Aprende más sobre como puedes contribuir.

Contributing to the Python Packaging Guide

Una guía creada por la comunidad

Cada página de esta guía pasa por un proceso exhaustivo de revisión comunitaria. Para que la guía sea accesible para principiantes y precisa, fomentamos la participación en las revisiones de personas de la comunidad de Python y de la comunidad científica con una amplia variedad de habilidades y conocimientos especializados.

Ver los colaboradores de la guía

A quién va dirigida esta guía

Esta guía es para cualquier persona interesada en aprender más sobre el empaquetado de Python. Es accesible para principiantes y proporcionará:

1. Orientación de principio a fin para crear un paquete de Python.

2. Recursos para ayudarte a navegar el ecosistema de herramientas y enfoques de empaquetado de Python.

3. Una lista de recursos seleccionados para ayudarte a documentar, usar y mantener tu paquete.

El futuro de esta guía

Si tienes ideas de cosas que te gustaría ver aclaradas en esta guía, te invitamos a abrir una incidencia (Issue) en GitHub..

Si tienes preguntas sobre nuestro proceso de revisión por pares (peer review) o sobre el empaquetado en general, puedes plantearlas en GitHub Discussions.

Esta es una guía en constante evolución que se actualiza a medida que las herramientas y las recomendaciones prácticas evolucionan en el ecosistema de empaquetado de Python. Estaremos añadiendo nuevo contenido durante el próximo año.