Crie e distribua seu próprio pacote Python

Tudo começa com a pergunta de como você pode criar e distribuir seus próprios pacotes Python de forma eficaz. Neste guia, mostrarei como você pode prosseguir passo a passo para desenvolver um pacote que pode disponibilizar para outros. É essencial criar os arquivos corretos e garantir a estrutura correta. Isso permite que outras pessoas instalem e usem seu pacote facilmente. Vamos mergulhar diretamente e explorar os fundamentos da distribuição de pacotes.

Principais insights

1. Crie um arquivo setup.py que contenha todos os metadados do seu pacote.
2. Adicione um arquivo Manifest que liste todos os arquivos não-Python.
3. Use o comando correto no terminal para criar sua distribuição.
4. O pacote descompactado pode ser facilmente passado para instalação.

Guia passo a passo

Existem algumas etapas cruciais que você deve seguir para criar seu próprio pacote Python. Abaixo, você encontrará um guia detalhado com capturas de tela que lhe mostrarão o caminho para sua própria distribuição de pacotes.

Criando a estrutura de diretórios

Primeiro, você deve preparar a estrutura de diretórios correta para o seu pacote. Crie um diretório principal que contenha todos os arquivos e subdiretórios, incluindo código-fonte, documentação e informações de licença.

Neste exemplo, estou preparando uma estrutura simples com um arquivo README.md e um arquivo de licença. Você pode usar a licença GPL para definir os direitos do seu pacote.

Definindo a estrutura da API

Para tornar seu pacote útil, você precisa de pelo menos uma documentação da API e uma classe base da qual outras classes possam herdar. Essa estrutura ajuda a possibilitar extensões e personalizações do seu pacote.

Uma classe de API simples e uma classe de inventário poderiam oferecer uma excelente introdução.

Criando o arquivo setup.py

Um componente central do seu pacote é o arquivo setup.py. Aqui, você define todas as informações do projeto necessárias durante o processo de instalação.

Neste arquivo, você importa os módulos necessários e fornece os detalhes básicos do seu pacote, incluindo nome, autor, e-mail, número da versão e site.

Especificação dos pacotes necessários

Você deve garantir que todas as dependências do seu pacote sejam especificadas. Isso acontece no setup.py, adicionando uma lista de pacotes que devem ser entregues junto com o seu pacote.

Adicione aqui todos os subpacotes necessários, como a classe base e classes específicas extensas.

Criando um arquivo Manifest

Para garantir que todos os arquivos relevantes não-Python sejam incluídos no seu pacote, crie um arquivo Manifest. Este arquivo lista todos os arquivos que devem ser considerados ao empacotar.

Neste arquivo, você especifica quais tipos de arquivos devem ser incluídos no pacote, assim como diretórios como, por exemplo, a documentação.

Comandos do terminal para criar a distribuição

Agora é hora de criar o pacote. Abra seu terminal e navegue até o diretório do seu setup.py. Aqui, você pode executar o comando para criar o pacote.

Verificando os arquivos criados

Após criar a distribuição, você deve encontrar um diretório chamado dist que contém o pacote empacotado.

Agora você pode compartilhar ou instalar esse arquivo.

Instalação do pacote

Para garantir que o pacote funcione corretamente, você pode reinstalá-lo. Para isso, descompacte o diretório e execute o arquivo setup.py novamente.

Para usuários que não possuem direitos de administrador, você pode executar o comando de instalação para o usuário atual:

python setup.py install --user

Distribuição para os usuários

Se você deseja distribuir seu pacote, assegure-se de que todos os arquivos, como README.md, licença e o setup.py, estejam anexados. Isso garante que o pacote possa ser instalado corretamente assim que o usuário baixá-lo.

Aqui está seu pacote pronto no sistema de arquivos e pode ser compartilhado com outros.

Resumo – Empacote seus pacotes Python corretamente

Você agora aprendeu como criar uma estrutura abrangente para seus pacotes Python e gerar com sucesso uma distribuição que pode ser facilmente distribuída. Desde a criação da estrutura de diretórios até a instalação pelo usuário final, você percorreu todas as etapas para distribuir seu próprio pacote de forma eficaz.