cookiecutter

Ausstecher

Erstellen Sie mit diesem Befehlszeilenprogramm schnell Projekte aus Cookie-Cuttern (Projektvorlagen). Ideal zum Generieren von Python-Paketprojekten und mehr.

• Dokumentation
• GitHub
• PyPI
• Lizenz (BSD)

Installation

Cookiecutter mit dem Pip-Paketmanager installieren:

 # 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

Merkmale

• Plattformübergreifend: Unterstützt Windows, Mac und Linux.
• Benutzerfreundlich: Keine Python-Kenntnisse erforderlich.
• Vielseitig: Kompatibel mit Python 3.7 bis 3.12.
• Mehrsprachige Unterstützung: Verwenden Sie Vorlagen in jeder Sprache oder jedem Markup-Format.

Für Benutzer

Schnellstart

Die empfohlene Methode, Cookiecutter als Befehlszeilenprogramm zu verwenden, besteht darin, es mit pipx auszuführen, das mit pip install pipx installiert werden kann. Wenn Sie Cookiecutter jedoch programmgesteuert verwenden möchten, führen Sie bitte pip install cookiecutter aus.

Verwenden Sie eine GitHub-Vorlage

 # 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

Verwenden Sie eine lokale Vorlage

$ pipx run cookiecutter cookiecutter-pypackage/

Verwenden Sie es von Python aus

 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' )

Detaillierte Verwendung

• Generieren Sie Projekte aus lokalen oder Remote-Vorlagen.
• Passen Sie Projekte mit cookiecutter.json -Eingabeaufforderungen an.
• Nutzen Sie Pre-Prompt-, Pre- und Post-Generate-Hooks.

Erfahren Sie mehr

Für Vorlagenersteller

• Nutzen Sie die unbegrenzte Verzeichnisverschachtelung.
• Nutzen Sie Jinja2 für alle Vorlagenanforderungen.
• Definieren Sie Vorlagenvariablen einfach mit cookiecutter.json .

Erfahren Sie mehr

Verfügbare Vorlagen

Entdecken Sie eine Vielzahl gebrauchsfertiger Vorlagen auf GitHub.

Spezielle Vorlagen

• cookiecutter-pypackage
• cookiecutter-django
• cookiecutter-pytest-plugin
• cookiecutter-plone-starter

Gemeinschaft

Treten Sie der Community bei, tragen Sie bei oder suchen Sie Hilfe.

• Leitfaden zur Fehlerbehebung
• Stapelüberlauf
• Zwietracht
• Melden Sie ein Problem
• Mitwirkende
• Beitragsleitfaden

Unterstützung

• Star uns auf GitHub.
• Bleiben Sie auf dem Laufenden über kommende Support-Optionen.

Rückmeldung

Wir schätzen Ihr Feedback. Teilen Sie Ihre Kritik oder Beschwerden konstruktiv mit, um uns bei der Verbesserung zu helfen.

• Melden Sie ein Problem

Warten Sie auf eine Antwort?

• Seien Sie geduldig und erwägen Sie, die Community um Hilfe zu bitten.
• In dringenden Fällen wenden Sie sich für eine Beratung oder kundenspezifische Entwicklung an @audreyfeldroy.

Verhaltenskodex

Halten Sie sich bei allen Interaktionen im Ökosystem des Projekts an den PyPA-Verhaltenskodex.

Danksagungen

Erstellt und geleitet von Audrey Roy Greenfeld, unterstützt von einem engagierten Team aus Betreuern und Mitwirkenden.