cookiecutter

เครื่องตัดคุกกี้

สร้างโปรเจ็กต์อย่างรวดเร็วจาก เครื่องตัดคุกกี้ (เทมเพลตโปรเจ็กต์) ด้วยยูทิลิตี้บรรทัดคำสั่งนี้ เหมาะสำหรับการสร้างโปรเจ็กต์แพ็คเกจ Python และอื่นๆ

• เอกสารประกอบ
• GitHub
• พีพีไอ
• ใบอนุญาต (BSD)

การติดตั้ง

ติดตั้งเครื่องตัดคุกกี้โดยใช้ตัวจัดการแพ็คเกจ 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

คุณสมบัติ

• ข้ามแพลตฟอร์ม: รองรับ 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
• ใช้ hooks ก่อนพร้อมท์ ก่อนและหลังสร้าง

เรียนรู้เพิ่มเติม

สำหรับผู้สร้างเทมเพลต

• ใช้ประโยชน์จากการซ้อนไดเรกทอรีได้ไม่จำกัด
• จ้าง Jinja2 สำหรับทุกความต้องการในการสร้างเทมเพลต
• กำหนดตัวแปรเทมเพลตได้อย่างง่ายดายด้วย cookiecutter.json

เรียนรู้เพิ่มเติม

เทมเพลตที่มีอยู่

ค้นพบเทมเพลตที่พร้อมใช้งานหลากหลายบน GitHub

เทมเพลตพิเศษ

• เครื่องตัดคุกกี้-pypackage
• เครื่องตัดคุกกี้-django
• cookiecutter-pytest-ปลั๊กอิน
• cookiecutter-plone-starter

ชุมชน

เข้าร่วมชุมชน มีส่วนร่วม หรือขอความช่วยเหลือ

• คู่มือการแก้ไขปัญหา
• กองล้น
• ความไม่ลงรอยกัน
• ยื่นประเด็น
• ผู้ร่วมให้ข้อมูล
• คู่มือการบริจาค

สนับสนุน

• ติดดาวเราบน GitHub
• คอยติดตามตัวเลือกการสนับสนุนที่กำลังจะมีขึ้น

ข้อเสนอแนะ

เราให้ความสำคัญกับความคิดเห็นของคุณ แบ่งปันคำวิจารณ์หรือข้อร้องเรียนของคุณอย่างสร้างสรรค์เพื่อช่วยเราปรับปรุง

• ยื่นประเด็น

กำลังรอการตอบกลับอยู่ใช่ไหม?

• อดทนและพิจารณาติดต่อกับชุมชนเพื่อขอความช่วยเหลือ
• สำหรับเรื่องเร่งด่วน โปรดติดต่อ @audreyfeldroy เพื่อขอคำปรึกษาหรือการพัฒนาแบบกำหนดเอง

หลักจรรยาบรรณ

ปฏิบัติตามหลักจรรยาบรรณของ PyPA ในระหว่างการโต้ตอบทั้งหมดในระบบนิเวศของโครงการ

รับทราบ

สร้างและนำโดย Audrey Roy Greenfeld โดยได้รับการสนับสนุนจากทีมงานผู้ดูแลและผู้มีส่วนร่วมโดยเฉพาะ