cookiecutter

Cortador de biscoitos

Crie projetos rapidamente a partir de cookiecutters (modelos de projeto) com este utilitário de linha de comando. Ideal para gerar projetos de pacotes Python e muito mais.

• Documentação
• GitHub
• PyPI
• Licença (BSD)

Instalação

Instale o cookiecutter usando o gerenciador de pacotes pip:

 # pipx is strongly recommended.
pipx install cookiecutter

# If pipx is not an option,
# you can install cookiecutter in your Python user directory.
python -m pip install --user cookiecutter

Características

• Plataforma cruzada: suporta Windows, Mac e Linux.
• Fácil de usar: não é necessário conhecimento de Python.
• Versátil: Compatível com Python 3.7 a 3.12.
• Suporte multilíngue: use modelos em qualquer idioma ou formato de marcação.

Para usuários

Início rápido

A maneira recomendada de usar o Cookiecutter como um utilitário de linha de comando é executá-lo com pipx , que pode ser instalado com pip install pipx , mas se você planeja usar o Cookiecutter programaticamente, execute pip install cookiecutter .

Use um modelo GitHub

 # You'll be prompted to enter values.
# Then it'll create your Python package in the current working directory,
# based on those values.
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ pipx run cookiecutter gh:audreyfeldroy/cookiecutter-pypackage

Use um modelo local

$ pipx run cookiecutter cookiecutter-pypackage/

Use-o em Python

 from cookiecutter . main import cookiecutter

# Create project from the cookiecutter-pypackage/ template
cookiecutter ( 'cookiecutter-pypackage/' )

# Create project from the cookiecutter-pypackage.git repo template
cookiecutter ( 'gh:audreyfeldroy//cookiecutter-pypackage.git' )

Uso detalhado

• Gere projetos a partir de modelos locais ou remotos.
• Personalize projetos com prompts cookiecutter.json .
• Utilize ganchos de pré-prompt, pré e pós-geração.

Saber mais

Para criadores de modelos

• Utilize aninhamento de diretório ilimitado.
• Empregue Jinja2 para todas as necessidades de modelagem.
• Defina variáveis ​​de modelo facilmente com cookiecutter.json .

Saber mais

Modelos disponíveis

Descubra uma variedade de modelos prontos para uso no GitHub.

Modelos Especiais

• pacote cookiecutter-py
• cookiecutter-django
• plugin cookiecutter-pytest
• cookiecutter-plone-starter

Comunidade

Junte-se à comunidade, contribua ou procure ajuda.

• Guia de solução de problemas
• Estouro de pilha
• Discórdia
• Registrar um problema
• Colaboradores
• Guia de contribuição

Apoiar

• Marque-nos no GitHub.
• Fique ligado nas próximas opções de suporte.

Opinião

Valorizamos seu feedback. Compartilhe suas críticas ou reclamações de forma construtiva para nos ajudar a melhorar.

• Registrar um problema

Esperando por uma resposta?

• Seja paciente e considere entrar em contato com a comunidade para obter assistência.
• Para assuntos urgentes, entre em contato com @audreyfeldroy para consulta ou desenvolvimento customizado.

Código de Conduta

Aderir ao Código de Conduta PyPA durante todas as interações no ecossistema do projeto.

Agradecimentos

Criado e liderado por Audrey Roy Greenfeld, apoiado por uma equipe dedicada de mantenedores e colaboradores.