Repolode
Enviar
pyscaffold

pyscaffold/pyscaffold

Gerador de projetos Python que cria pacotes instaláveis e prontos para o PyPI, com tox, pytest, documentação Sphinx e versionamento Git pré-configurados.

Ver no GitHubSite
Estrelas
2,260
Forks
187
Issues abertas
37
Último commit
há 5 dias

O que é?

PyScaffold é um gerador de projetos Python pela linha de comando. Ao executar `putup my_project`, você cria a estrutura básica de um pacote com configuração baseada em setup.cfg, layout src, uma pasta de testes e um diretório de documentação Sphinx. Assim, é possível desenvolver, testar e publicar uma nova biblioteca sem escrever o código boilerplate à mão.

O template gerado configura ferramentas comuns: tarefas do tox para compilar e publicar no test.pypi.org e no PyPI, pytest com pytest-cov para medir a cobertura e, opcionalmente, hooks de pre-commit e configuração de CI para Cirrus CI. As versões são inferidas a partir das tags do Git usando setuptools_scm, e um .gitignore padrão também é incluído.

É possível converter projetos existentes usando a opção force, e `putup --update` aplica ao projeto as atualizações posteriores do scaffold. Recursos adicionais, como layout para ciência de dados, READMEs em Markdown, suporte a Django e seleção de licença, estão disponíveis por meio de extensões ou flags.

Recursos principais

  • 01Gera um pacote Python com layout src e configuração baseada em setup.cfg.
  • 02Infere os números de versão a partir das tags do Git usando setuptools_scm.
  • 03Pré-configura tarefas do tox para compilar e publicar no PyPI.
  • 04Inclui configuração de pytest e pytest-cov, além de um diretório de documentação Sphinx.
  • 05Oferece suporte opcional a hooks de pre-commit, arquivos do Cirrus CI e seleção de licença.
  • 06Permite atualizar scaffolds existentes com `putup --update`.

Casos de uso

  • Iniciar uma nova biblioteca Python que será publicada no PyPI.
  • Padronizar a estrutura dos pacotes e as ferramentas nos projetos Python de uma equipe.
  • Converter um repositório Git existente em um projeto Python empacotado e documentado.

Início rápido

  1. 1

    Instale o PyScaffold com pip

    pip install pyscaffold
  2. 2

    Crie um novo projeto com putup

    putup my_project
  3. 3

    Acesse o projeto e instale-o em modo editável

    pip install -e .

Antes de usar

  • O README informa que a versão mais recente é a v4; a versão estável anterior é a v3.3.
  • Para o PyScaffold funcionar, é necessário instalar o Git e configurá-lo com seu nome e e-mail.

Tópicos

#python#project-template#packaging#scaffolding#pypi#tox#sphinx#pytest#distribution#git

Perguntas frequentes

O que é pyscaffold?
Gerador de projetos Python que cria pacotes instaláveis e prontos para o PyPI, com tox, pytest, documentação Sphinx e versionamento Git pré-configurados. PyScaffold é um gerador de projetos Python pela linha de comando. Ao executar `putup my_project`, você cria a estrutura básica de um pacote com configuração baseada em setup.cfg, layout src, uma pasta de testes e um diretório de documentação Sphinx. Assim, é possível desenvolver, testar e publicar uma nova biblioteca sem escrever o código boilerplate à mão.
pyscaffold é gratuito? Qual é a licença?
pyscaffold é open source sob a licença Other. Confira os termos da licença antes de usá-lo em produtos comerciais.
pyscaffold ainda é mantido?
Manutenção ativa. O último commit de pyscaffold foi em 2 de nov. de 2026.
Para que posso usar pyscaffold?
Iniciar uma nova biblioteca Python que será publicada no PyPI. Padronizar a estrutura dos pacotes e as ferramentas nos projetos Python de uma equipe. Converter um repositório Git existente em um projeto Python empacotado e documentado.
Como instalar pyscaffold?
Instale o PyScaffold com pip: pip install pyscaffold Crie um novo projeto com putup: putup my_project Acesse o projeto e instale-o em modo editável: pip install -e .
Onde consigo pyscaffold?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/pyscaffold/pyscaffold

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

Projetos relacionados