Usando o Hatch para migrar setup.py para pyproject.toml#

O Hatch pode ser útil para gerar o arquivo pyproject.toml do seu projeto se ele já tiver um arquivo setup.py.

Nota

Esta etapa não é necessária e só é útil se seu projeto já tiver um arquivo setup.py definido.

Se seu projeto ainda não define um setup.py, consulte Torne seu código Python instalável

Objetivos de Aprendizagem

Nesta lição, você aprenderá:

O processo de usar o Hatch para fazer a transição para pyproject.toml em projetos que já têm um setup.py definido.

O que é o Hatch?#

O Hatch é um gerenciador de pacote Pythons projetado para simplificar o processo de criar, gerenciar e distribuir pacote Pythons. Ele oferece uma CLI (Command-Line Interface) conveniente para tarefas como criar novos projetos, gerenciar dependências, fazer build de distribuições e publicar pacotes em repositórios como o PyPI.

Conheça o Hatch

Consulte Conheça o Hatch para mais informações.

Pré-requisitos#

Antes de começar, certifique-se de que o Hatch está instalado no seu sistema. Você pode instalá-lo via pip:

pipx install hatch

Árvore de diretórios de exemplo#

Vamos dar uma olhada em uma estrutura de árvore de diretórios de exemplo antes e depois de usar hatch init:

Antes de `hatch init`#

project/
│
├── src/
│   └── my_package/
│       ├── __init__.py
│       └── module.py
│
├── tests/
│   └── test_module.py
│
└── setup.py

Depois de `hatch init`#

project/
│
├── pyproject.toml
│
├── src/
│   └── my_package/
│       ├── __init__.py
│       └── module.py
│
├── tests/
│   └── test_module.py
│
└── setup.py

Como você pode ver, a principal mudança após executar hatch init é a adição do arquivo pyproject.toml no diretório do projeto.

Guia passo a passo#

Agora, vamos percorrer os passos para usar o Hatch e criar um arquivo pyproject.toml para seu projeto.

Navegue até o diretório do seu projeto: Abra seu terminal ou prompt de comando e navegue até o diretório onde seu projeto Python está localizado.
Inicialize o Hatch: Execute o seguinte comando para inicializar o Hatch no diretório do seu projeto:
```
hatch new --init
```
Revise e personalize: Após executar o comando anterior, o Hatch gerará automaticamente um arquivo pyproject.toml com base na configuração existente do seu projeto. Reserve um tempo para revisar o conteúdo do arquivo pyproject.toml gerado. Você pode querer personalizar certas configurações ou dependências com base nos requisitos do seu projeto (consulte o tutorial de pyproject.toml para mais informações sobre o pyproject.toml).
Verifique: Verifique se o arquivo pyproject.toml reflete com precisão a configuração e as dependências do seu projeto. Você pode editar o arquivo manualmente, mas tenha cuidado e certifique-se de que a sintaxe está correta.
Exclua o setup.py: Como estamos migrando para usar exclusivamente pyproject.toml, o arquivo setup.py se torna desnecessário. Você pode excluí-lo com segurança do diretório do seu projeto.
Teste o build: Antes de prosseguir, é essencial garantir que seu projeto faz build com sucesso usando apenas o arquivo pyproject.toml. Execute o seguinte comando para fazer o build do seu projeto:

hatch build

Este comando fará o build do seu projeto com base nas especificações do arquivo pyproject.toml. Certifique-se de verificar se há erros ou avisos durante o processo de build.

Teste a funcionalidade existente: Após fazer o build do seu projeto com sucesso com pyproject.toml, é crucial garantir que a funcionalidade existente do seu projeto permaneça intacta. Execute quaisquer testes pré-existentes para verificar se tudo ainda funciona como esperado.