Pon en marcha tu paquete convirtiendo scripts que ya has escrito. Crearás un paquete sencillo que podrás usar en tu propio ordenador.

Empezar un paquete

Módulos, paquetes y subpaquetes

De script a paquete

Poniendo tu paquete en acción

Documentación

Escribir la documentación de funciones con pyment

Escribir documentación de funciones con pyment II

Documentación de paquetes y módulos

Estructurar las importaciones

Imports entre módulos hermanos

Importar desde paquetes padre

Exponer funciones a las personas usuarias

De código suelto a paquete local

Haz que tu paquete sea instalable para ti y para otras personas. En este capítulo, aprenderás a gestionar dependencias, escribir READMEs e incluir licencias. También completarás todos los pasos para publicar tu paquete en PyPI, el principal hogar de los paquetes de Python.

Instalar tu propio paquete

Añadir el script de configuración

Instalar tu paquete localmente

Usar instalaciones editables

Gestionar las dependencias

Dependencias del usuario

Dependencias de desarrollo

Incluir licencias y escribir READMEs

Escribir un README

MANIFEST - Incluir archivos extra con tu paquete

Publicar tu paquete

Crear una distribución

Subir distribuciones

Instala tu paquete desde cualquier lugar

Lleva tu paquete a un nivel profesional. Descubre cómo usar pytest para evitar errores, tox para probar tu paquete con varias versiones de Python y flake8 para mantener un gran estilo de código.

Probar tu paquete

from impyrial.length.core import inches_to_feet, inches_to_yards


Creación del directorio de tests

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def ____():
	# Check that 12 inches is converted to 1.0 foot
    ____ ____(____) == 1.0 
    # Check that 2.5 feet is converted to 30.0 inches
    ____ ____(____, reverse=True) == ____


from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1.0 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30.0 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0


Escribir algunas pruebas básicas

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0
    


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 120  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 12.0  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


Ejecutar tus tests

Probar tu paquete en distintos entornos

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


Configurando tox

[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest
    


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    #python_requires="==____.*",
)


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.9.*",
)


Ejecutar tox

Mantén tu paquete con estilo

Filtrado de estilo apropiado

"""Main module."""

def absolute_value(num):
    """Return the absolute value of the number"""
    if num>=0: return num
    else:
    	return -num


"""Main module."""


def absolute_value(num):
    """Return the absolute value of the number"""
    if num >= 0:
        return num
    else:
        return -num


Usar flake8 para limpiar un archivo

import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # ____: ____
    return l


import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # noqa: E741
    return l


Ignorar errores específicos

[flake8]

# Ignore F401 violations in the main __init__.py file
# per-file-ignores =
#     ____ : ____
        
# Ignore all violations in the tests directoory
# exclude = ____


from impyrial.length.api import (
    convert_unit,
    unit_to_mixed,
    mixed_to_unit,
)

def test_convert_unit():
    assert convert_unit(30, "ft", "in")==360.0
    assert convert_unit(30, "yd", "ft")==90.0
    assert convert_unit(10, "mi", "yd")==17600.0


[flake8]

# Ignore F401 violations in the main __init__.py file
per-file-ignores =
    impyrial/__init__.py: F401
        
# Ignore all violations in the tests directoory
exclude = tests/*


Configurar flake8

Mejora la calidad de tu paquete

Crea tus paquetes más rápido. En este último capítulo, aprenderás a usar cookiecutter para generar todos los archivos de soporte que necesita tu paquete, Makefiles para simplificar la publicación de nuevas versiones y conocerás los últimos archivos que ayudarán a atraer usuarios y personas colaboradoras.

Desarrollo de paquetes más rápido con plantillas

Uso de plantillas de paquetes

Números de versión e historial

CONTRIBUTING.md

Archivo de historial

Seguimiento de la versión con bumpversion

Makefiles y clasificadores

Clasificadores de PyPI

Usar Makefiles

Cierre

Desarrollo rápido de paquetes

¿Sueles copiar y pegar el mismo código entre archivos y te gustaría reutilizar y compartir fácilmente esos fragmentos tan útiles? ¡Empaquetar tu código en paquetes de Python puede ayudarte! En este curso, aprenderás sobre la estructura de un paquete y los archivos adicionales necesarios para convertir código suelto en paquetes prácticos. También verás la estructura de importación, la documentación y cómo mantener el estilo de código con flake8. Después acelerarás el desarrollo creando plantillas y usando cookiecutter para generar esqueletos de paquetes. Por último, aprenderás a usar setuptools y twine para compilar y publicar tus paquetes en PyPI, el escaparate mundial de los paquetes de Python.

Introduction to Shell

Writing Functions in Python

Aprende sobre estructura de paquetes, importaciones, documentación y estilo de código, luego publica plantillas.

Desarrollo de paquetes en Python

Aprende a crear tus propios paquetes Python para que el código sea más fácil de usar y compartir con otros.

Ejecutar tus tests

Desarrollo de paquetes en Python

Ejercicio interactivo práctico