cookiecutter

cortador de galletas

Cree proyectos rápidamente a partir de cortadores de galletas (plantillas de proyectos) con esta utilidad de línea de comandos. Ideal para generar proyectos de paquetes Python y más.

• Documentación
• GitHub
• PyPI
• Licencia (BSD)

Instalación

Instale cookiecutter usando el administrador de paquetes 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

• Multiplataforma: compatible con Windows, Mac y Linux.
• Fácil de usar: no se requieren conocimientos de Python.
• Versátil: Compatible con Python 3.7 a 3.12.
• Compatibilidad con varios idiomas: utilice plantillas en cualquier idioma o formato de marcado.

Para usuarios

Inicio rápido

La forma recomendada de utilizar Cookiecutter como utilidad de línea de comandos es ejecutarlo con pipx , que se puede instalar con pip install pipx , pero si planea utilizar Cookiecutter mediante programación, ejecute pip install cookiecutter .

Utilice una plantilla de 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

Utilice una plantilla local

$ pipx run cookiecutter cookiecutter-pypackage/

Úselo desde 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 detallado

• Genere proyectos a partir de plantillas locales o remotas.
• Personalice proyectos con indicaciones cookiecutter.json .
• Utilice ganchos previos al aviso, previos y posteriores a la generación.

Más información

Para creadores de plantillas

• Utilice anidamiento de directorios ilimitado.
• Emplee Jinja2 para todas las necesidades de plantillas.
• Defina variables de plantilla fácilmente con cookiecutter.json .

Más información

Plantillas disponibles

Descubra una variedad de plantillas listas para usar en GitHub.

Plantillas especiales

• paquete pycortador de galletas
• cookiecutter-django
• complemento-pytest-cookiecutter
• cookiecutter-plone-iniciador

Comunidad

Únase a la comunidad, contribuya o busque ayuda.

• Guía de solución de problemas
• Desbordamiento de pila
• Discordia
• Presentar un problema
• Colaboradores
• Guía de contribución

Apoyo

• Destacanos en GitHub.
• Estén atentos a las próximas opciones de soporte.

Comentario

Valoramos sus comentarios. Comparta sus críticas o quejas de manera constructiva para ayudarnos a mejorar.

• Presentar un problema

¿Esperando una respuesta?

• Sea paciente y considere pedir ayuda a la comunidad.
• Para asuntos urgentes, comuníquese con @audreyfeldroy para consultas o desarrollo personalizado.

Código de conducta

Adherirse al Código de Conducta de PyPA durante todas las interacciones en el ecosistema del proyecto.

Expresiones de gratitud

Creado y dirigido por Audrey Roy Greenfeld, con el respaldo de un equipo dedicado de mantenedores y contribuyentes.