cookiecutter

クッキーカッター

このコマンドライン ユーティリティを使用して、クッキーカッター(プロジェクト テンプレート) からプロジェクトを迅速に作成します。 Python パッケージ プロジェクトなどの生成に最適です。

• ドキュメント
• GitHub
• PyPI
• ライセンス (BSD)

インストール

pip パッケージ マネージャーを使用して cookiecutter をインストールします。

 # 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

特徴

• クロスプラットフォーム: Windows、Mac、Linux をサポートします。
• ユーザーフレンドリー: Python の知識は必要ありません。
• 多用途: Python 3.7 ～ 3.12 と互換性があります。
• 多言語サポート:任意の言語またはマークアップ形式のテンプレートを使用します。

ユーザー向け

クイックスタート

Cookiecutter をコマンド ライン ユーティリティとして使用する推奨方法は、 pipxで実行することです。これはpip install pipxでインストールできますが、Cookiecutter をプログラムで使用する予定がある場合は、 pip install cookiecutter実行してください。

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

ローカルテンプレートを使用する

$ pipx run cookiecutter cookiecutter-pypackage/

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

詳しい使い方

• ローカルまたはリモートのテンプレートからプロジェクトを生成します。
• cookiecutter.jsonプロンプトを使用してプロジェクトをカスタマイズします。
• プロンプト前、生成前および生成後のフックを利用します。

もっと詳しく知る

テンプレート作成者向け

• 無制限のディレクトリネストを利用します。
• すべてのテンプレートのニーズに Jinja2 を使用してください。
• cookiecutter.jsonを使用してテンプレート変数を簡単に定義します。

もっと詳しく知る

利用可能なテンプレート

GitHub ですぐに使用できるさまざまなテンプレートを見つけてください。

特別なテンプレート

• クッキーカッター-pyパッケージ
• クッキーカッタージャンゴ
• クッキーカッター-pytest-プラグイン
• クッキーカッター・プレーン・スターター

コミュニティ

コミュニティに参加したり、貢献したり、支援を求めたりしてください。

• トラブルシューティングガイド
• スタックオーバーフロー
• 不和
• 問題を提出する
• 貢献者
• 貢献ガイド

サポート

• GitHub でスターを付けてください。
• 今後のサポート オプションにご期待ください。

フィードバック

私たちはあなたのフィードバックを大切にしています。改善に役立てるため、批判や苦情を建設的に共有してください。

• 問題を提出する

応答を待っていますか?

• 辛抱強く、コミュニティに支援を求めることを検討してください。
• 緊急の問題については、@audreyfeldroy までご連絡の上、ご相談またはカスタム開発を行ってください。

行動規範

プロジェクトのエコシステム内でのすべてのやり取り中、PyPA の行動規範を遵守してください。

謝辞

Audrey Roy Greenfeld によって作成および主導され、メンテナーと貢献者の専任チームによってサポートされています。