Comece seu pacote convertendo scripts que você já escreveu. Você vai criar um pacote simples para usar no seu próprio computador.

Iniciando um pacote

Módulos, pacotes e subpacotes

Do script ao pacote

Colocando seu pacote para trabalhar

Documentação

Escrevendo documentação de funções com pyment

Escrevendo documentação de funções com pyment II

Documentação de pacote e módulo

Estruturando imports

Imports entre módulos irmãos

Importando do pacote pai

Expondo funções para usuários

De código solto a pacote local

Deixe seu pacote instalável para você e para outras pessoas. Neste capítulo, você vai aprender a lidar com dependências, escrever READMEs e incluir licenças. Você também vai concluir todas as etapas para publicar seu pacote no PyPI — a principal casa dos pacotes Python.

Instalando seu próprio pacote

Adicionando o script de setup

Instalando seu pacote localmente

Usando instalações editáveis

Lidando com dependências

Dependências do usuário

Dependências de desenvolvimento

Incluindo licenças e escrevendo READMEs

Escrevendo um README

MANIFEST - Incluindo arquivos extras no seu pacote

Publicando seu pacote

Gerando uma distribuição

Enviando distribuições

Instale seu pacote de qualquer lugar

Leve seu pacote a um padrão profissional. Descubra como usar pytest para evitar erros, tox para testar se seu pacote funciona com várias versões do Python e flake8 para manter um ótimo estilo de código.

Testando seu pacote

from impyrial.length.core import inches_to_feet, inches_to_yards


Criando o diretório de testes

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


Escrevendo alguns testes básicos

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


Executando seus testes

Testando seu pacote em diferentes ambientes

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


Configurando o 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.*",
)


Executando o tox

Mantendo seu pacote estiloso

Filtragem adequada de estilo

"""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


Usando flake8 para deixar um arquivo em ordem

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


Ignorando erros 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/*


Configurando o flake8

Aumentando a qualidade do seu pacote

Crie seus pacotes com mais rapidez. Neste capítulo final, você vai aprender a usar cookiecutter para gerar todos os arquivos de suporte de que seu pacote precisa, Makefiles para simplificar o lançamento de novas versões e terá uma introdução aos últimos arquivos que seu pacote precisa para atrair usuários e contribuintes.

Desenvolvimento mais rápido de pacotes com templates

Usando modelos de pacote

Números de versão e histórico

CONTRIBUTING.md

Arquivo de histórico

Acompanhando o número da versão com bumpversion

Makefiles e classificadores

Classificadores do PyPI

Usando Makefiles

Encerramento

Desenvolvimento rápido de pacotes

Você vive copiando e colando o mesmo código entre arquivos e queria que fosse mais fácil reutilizar e compartilhar seus trechos incríveis? Empacotar seu código em pacotes Python pode ajudar! Neste curso, você vai aprender sobre a estrutura de pacotes e os arquivos extras necessários para transformar códigos soltos em pacotes práticos. Você também vai aprender sobre a estrutura de imports, documentação e como manter o estilo do código usando o flake8. Depois, vai acelerar o desenvolvimento dos seus pacotes criando templates, usando o cookiecutter para gerar esqueletos de pacotes. Por fim, você vai aprender a usar setuptools e twine para construir e publicar seus pacotes no PyPI — o palco mundial dos pacotes Python.

Introduction to Shell

Writing Functions in Python

Aprenda sobre estrutura de pacotes, importação, documentação e estilo de código. Construa e publique.

Desenvolvendo pacotes Python

Aprenda a criar pacotes Python para tornar seu código mais fácil de usar e compartilhar com outras pessoas.

Usando flake8 para deixar um arquivo em ordem

Desenvolvendo pacotes Python

Exercício interativo prático