cookiecutter

pemotong kue

Buat proyek dengan cepat dari cookiecutters (templat proyek) dengan utilitas baris perintah ini. Ideal untuk menghasilkan proyek paket Python dan banyak lagi.

• Dokumentasi
• GitHub
• PyPI
• Lisensi (BSD)

Instalasi

Instal cookiecutter menggunakan manajer paket 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

Fitur

• Lintas Platform: Mendukung Windows, Mac, dan Linux.
• Ramah Pengguna: Tidak diperlukan pengetahuan Python.
• Serbaguna: Kompatibel dengan Python 3.7 hingga 3.12.
• Dukungan Multi-Bahasa: Gunakan templat dalam bahasa atau format markup apa pun.

Untuk Pengguna

Mulai Cepat

Cara yang disarankan untuk menggunakan Cookiecutter sebagai utilitas baris perintah adalah menjalankannya dengan pipx , yang dapat diinstal dengan pip install pipx , tetapi jika Anda berencana menggunakan Cookiecutter secara terprogram, jalankan pip install cookiecutter .

Gunakan templat 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

Gunakan templat lokal

$ pipx run cookiecutter cookiecutter-pypackage/

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

Penggunaan Terperinci

• Hasilkan proyek dari templat lokal atau jarak jauh.
• Sesuaikan proyek dengan perintah cookiecutter.json .
• Gunakan kait sebelum, sebelum, dan sesudah pembuatan.

Pelajari Lebih Lanjut

Untuk Pembuat Templat

• Memanfaatkan sarang direktori tanpa batas.
• Gunakan Jinja2 untuk semua kebutuhan templating.
• Tentukan variabel templat dengan mudah menggunakan cookiecutter.json .

Pelajari Lebih Lanjut

Template yang Tersedia

Temukan berbagai templat siap pakai di GitHub.

Templat Khusus

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

Masyarakat

Bergabunglah dengan komunitas, berkontribusi, atau mencari bantuan.

• Panduan Mengatasi Masalah
• Tumpukan Melimpah
• Perselisihan
• Ajukan Masalah
• Kontributor
• Panduan Kontribusi

Mendukung

• Bintangi kami di GitHub.
• Nantikan opsi dukungan yang akan datang.

Masukan

Kami menghargai masukan Anda. Sampaikan kritik atau keluhan Anda secara membangun untuk membantu kami menjadi lebih baik.

• Ajukan Masalah

Menunggu Jawaban?

• Bersabarlah dan pertimbangkan untuk menjangkau masyarakat untuk mendapatkan bantuan.
• Untuk masalah mendesak, hubungi @audreyfeldroy untuk konsultasi atau pengembangan khusus.

Kode Etik

Patuhi Kode Etik PyPA selama semua interaksi dalam ekosistem proyek.

Ucapan Terima Kasih

Dibuat dan dipimpin oleh Audrey Roy Greenfeld, didukung oleh tim pengelola dan kontributor yang berdedikasi.