Aprenda a criar e publicar um pacote Python

Como criar um pacote Python?

Os pacotes Python são coleções de módulos organizados em diretórios, permitindo melhor estruturação e reutilização de código.

Estruturando um pacote

Para criar um pacote, organize os arquivos da seguinte forma:

meu_pacote/  
    __init__.py  
    modulo1.py  
    modulo2.py  
    setup.py  
    README.md  

• O arquivo __init__.py indica que a pasta meu_pacote é um pacote Python.
• Os módulos modulo1.py e modulo2.py contêm as funcionalidades.
• setup.py é o arquivo de configuração para distribuição do pacote.

Criando o arquivo setup.py

O setup.py é fundamental para empacotar e distribuir o pacote:

from setuptools import setup, find_packages  

setup(  
    name='meu_pacote',  
    version='0.1',  
    packages=find_packages(),  
    install_requires=[],  
    author='Seu Nome',  
    description='Um pacote de exemplo em Python',  
)  

Isso define o nome, versão, pacotes incluídos e dependências.

Instalando o pacote localmente

Após configurar o pacote, instale-o localmente:

pip install .  

Isso tornará o pacote disponível para importação no ambiente.

Publicando no PyPI

Para distribuir o pacote no PyPI, instale as ferramentas necessárias:

pip install twine setuptools wheel  

Gere os arquivos do pacote:

python setup.py sdist bdist_wheel  

Envie o pacote para o PyPI:

twine upload dist/*  

Isso disponibilizará o pacote para instalação pública via pip install meu_pacote.

Por que criar pacotes Python?

Criar e distribuir pacotes Python permite compartilhar soluções reutilizáveis com a comunidade e melhorar a organização do código.

Algumas aplicações:

• Organização de código reutilizável.
• Facilidade na distribuição de funcionalidades para outros projetos.
• Publicação de bibliotecas Python no PyPI.
• Uso em projetos colaborativos.

Dicas para quem está começando

• Utilize virtualenv para testar pacotes antes da publicação.
• Adicione um README.md detalhado para documentar o uso do pacote.
• Use pip install -e . para testar o pacote em modo de desenvolvimento.
• Explore setuptools.find_packages() para detectar módulos automaticamente.

Compartilhe este tutorial