Repolode
Enviar
mgedmin

mgedmin/check-manifest

Ferramenta de linha de comando que verifica se o sdist de um pacote Python inclui todos os arquivos sob controle de versão e pode atualizar o MANIFEST.in para corrigir omissões.

Ver no GitHubSite
Estrelas
293
Forks
44
Issues abertas
29
Último commit
há 19 dias

O que é?

check-manifest é uma ferramenta de linha de comando para autores de pacotes Python. Ela compara os arquivos rastreados pelo controle de versão (como git ou Mercurial) com o conteúdo da distribuição de código-fonte (sdist) gerada e informa quais arquivos estão faltando no pacote. Isso ajuda a detectar um erro comum de empacotamento: deixar arquivos de teste, configuração ou dados de fora de uma versão publicada no Python Package Index.

Ao ser executada com a opção de atualização, a ferramenta acrescenta ao MANIFEST.in regras de inclusão sugeridas para que os arquivos ausentes sejam incluídos na próxima build. Também é possível criar um MANIFEST.in caso ele não exista e ignorar arquivos ou padrões específicos usando as configurações em pyproject.toml, setup.cfg ou tox.ini.

A ferramenta pode ser executada diretamente pelo shell ou como um hook de pre-commit, permitindo que a verificação rode automaticamente antes de cada commit. A configuração é feita por flags de linha de comando e pela seção [tool.check-manifest] de pyproject.toml ou pela seção [check-manifest] de setup.cfg ou tox.ini.

Recursos principais

  • 01Compara os arquivos sob controle de versão com o sdist gerado e lista tudo o que está faltando.
  • 02Pode acrescentar automaticamente regras de inclusão sugeridas ao MANIFEST.in.
  • 03Cria um MANIFEST.in quando não existe um.
  • 04Permite ignorar arquivos ou padrões por meio de pyproject.toml, setup.cfg ou tox.ini.
  • 05Funciona como hook de pre-commit.

Casos de uso

  • Verificar se um pacote Python publicado no PyPI inclui todos os arquivos de teste e dados.
  • Executar uma verificação automática do empacotamento antes de cada commit no git usando pre-commit.
  • Corrigir um MANIFEST.in incompleto depois de uma reorganização do projeto.

Início rápido

  1. 1

    Instale check-manifest pelo PyPI

    pip install check-manifest
  2. 2

    Acesse o diretório de código-fonte do seu pacote Python

    cd ~/src/mygreatpackage
  3. 3

    Execute check-manifest para comparar os arquivos sob controle de versão com o sdist

    check-manifest

Tópicos

#python#packaging#manifest-in#sdist#pypi#pre-commit#developer-tools

Perguntas frequentes

O que é check-manifest?
Ferramenta de linha de comando que verifica se o sdist de um pacote Python inclui todos os arquivos sob controle de versão e pode atualizar o MANIFEST.in para corrigir omissões. check-manifest é uma ferramenta de linha de comando para autores de pacotes Python. Ela compara os arquivos rastreados pelo controle de versão (como git ou Mercurial) com o conteúdo da distribuição de código-fonte (sdist) gerada e informa quais arquivos estão faltando no pacote. Isso ajuda a detectar um erro comum de empacotamento: deixar arquivos de teste, configuração ou dados de fora de uma versão publicada no Python Package Index.
check-manifest é gratuito? Qual é a licença?
check-manifest é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
check-manifest ainda é mantido?
Manutenção ativa. O último commit de check-manifest foi em 18 de out. de 2026.
Para que posso usar check-manifest?
Verificar se um pacote Python publicado no PyPI inclui todos os arquivos de teste e dados. Executar uma verificação automática do empacotamento antes de cada commit no git usando pre-commit. Corrigir um MANIFEST.in incompleto depois de uma reorganização do projeto.
Como instalar check-manifest?
Instale check-manifest pelo PyPI: pip install check-manifest Acesse o diretório de código-fonte do seu pacote Python: cd ~/src/mygreatpackage Execute check-manifest para comparar os arquivos sob controle de versão com o sdist: check-manifest
Onde consigo check-manifest?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/mgedmin/check-manifest

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados