Introdução

PyFabricate é um aplicativo Mac OS X que simplifica a criação de projetos Python. Como eu o escrevi, obviamente é uma versão opinativa de como eu acho que um projeto Python deveria ser. Além disso, tenho um determinado conjunto de ferramentas que uso para poder escrever aplicativos Python para Mac OS X. No entanto, tentei criar um pouco de personalização expondo os modelos a partir dos quais crio os arquivos do projeto. Mais sobre isso mais tarde.

Visão geral

PyFabricate usa uma interface semelhante a um assistente para consultar os detalhes do projeto.

Suposições opinativas

• O desenvolvedor usa o HomeBrew para instalar as dependências opinativas.

  • Python é gerenciado via pyenv (para uso nos ambientes virtuais criados)
  • direnv está instalado (opcional)

• O nome do projeto é igual ao nome do pacote do módulo

Instalação

Obtenha a versão atual aqui.

Copie este arquivo para a pasta de aplicativos do Mac OS. O aplicativo é assinado com código Apple, então você receberá uma mensagem simples que deverá confirmar na primeira vez que executá-lo.

Detalhes do esqueleto do projeto

A seguir está um exemplo do esqueleto inicial que o PyFabricator cria. Agora mostra o ambiente virtual que cria. Mais sobre isso mais tarde.

Essencialmente, PyFabricate cria os diretórios src e testa. No diretório raiz do projeto ele cria os seguintes arquivos:

• .envrc
• .gitignore
• .mypi.ini
• .python_versão
• .LICENÇA
• README.md
• pyproject.toml
• requisitos.txt

Além disso, PyFabricate cria todos os arquivos do pacote python (__init__.py) em todos os locais apropriados. E, finalmente, ele coloca dois conjuntos de arquivos de configuração de log, um para sua aplicação e outro para seus testes de unidade.

No final da fabricação, PyFabricate cria um ambiente virtual Python. Devido a limitações técnicas, o PyFabricate não pode usar uma versão pyenv do Python para criar o ambiente virtual. Portanto, depende de uma versão homebrew instalada.

IU do assistente

A IU do assistente é um processo de 4 etapas em que o PyFabricate reúne detalhes suficientes do projeto para preencher os modelos de esqueleto. Os modelos usam os seguintes tokens de substituição autoexplicativos.

A seguir está um gráfico anotado do modelo pyroject.toml.

Etapa 1 da IU do assistente - Introdução

Esta etapa é uma introdução ao PyFabricate. Após esta etapa, o PyFabricate faz o possível para garantir que suas dependências de execução sejam atendidas. Caso contrário, o desenvolvedor não poderá prosseguir nesta etapa.

Etapa 2 da IU do assistente - Detalhes do projeto

Nesta etapa, o PyFabricate coleta informações específicas do projeto. A maior parte disso serve para preencher o modelo pyproject.toml.

Etapa 3 da UI do assistente - Diretório base

PyFabricate assume que o desenvolvedor mantém todos os seus projetos Python em um único subdiretório. Esta é uma visão opinativa e é simplesmente uma preferência organizacional.

UI do assistente, etapa 4 - versão Python

PyFabricate consulta pyenv para as versões Python instaladas pelo desenvolvedor. Estes são os únicos a partir dos quais o PyFabricate pode criar ambientes virtuais Python.

Registro de ações

No final do assistente, PyFabricate apresenta um log à medida que cria o projeto. A seguir está um exemplo de log.

Personalização

Como mencionado anteriormente, o desenvolvedor pode personalizar alguns aspectos da geração do projeto. PyFabricate armazena os modelos que usa em $HOME/.config/pyfabricate/templates conforme observado abaixo.

Por exemplo, um desenvolvedor pode querer usar uma licença diferente. Simplesmente, substitua o arquivo LICENSE.template

Concluir

PyFabricate está atualmente apenas na versão 0.5.0. No momento, estou investigando a adição de recursos adicionais e a remoção de limitações.