หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>โค้ดแหล่งที่มา AI
ดาวน์โหลด

cookiecutter hatch pypackage

เทมเพลต Cookiecutter สำหรับแพ็คเกจ Python ที่ล้ำสมัย: Hatch , ruff , mypy , GitHub Actions และอีกมากมาย!

รายละเอียด
คุณสมบัติ

คุณสมบัติ

  • สตาร์ทเตอร์น้ำหนักเบา
  • การจัดการแพ็คเกจ Hatch
  • hath-vcs: กำหนดเวอร์ชันของแพ็คเกจโดยอัตโนมัติจากแท็ก git เช่น v0.9
  • การขลิบและจัดรูปแบบด้วย ruff ซึ่งมาแทนที่ isort, flake8, สีดำ ฯลฯ
  • พิมพ์การตรวจสอบด้วย mypy
  • ตรวจสอบการขึ้นต่อกันที่ไม่ได้ใช้ หายไป และสกรรมกริยาด้วย deptry
  • การทดสอบหน่วยด้วย pytest พร้อมการตั้งค่า asyncio ที่เป็นตัวเลือก
  • ทำการทดสอบอัตโนมัติและเป็นมาตรฐานด้วย Hatch-env-matrices
  • เอกสารประกอบพร้อม Material สำหรับ MkDocs และการสนับสนุนการอ้างอิง docstring ด้วย mkdocstrings
  • ไปป์ไลน์ GitHub Actions ที่พร้อมใช้งานพร้อม dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows และอื่นๆ
  • hatch-pip-compile: การสนับสนุน การทดลอง สำหรับไฟล์ล็อค
  • pyproject.toml: แพ็คเกจ บิลด์ และการกำหนดค่าเครื่องมือทั้งหมดในไฟล์เดียว
  • ความครอบคลุม: เครื่องมือสำหรับการวัดการครอบคลุมโค้ดของโปรแกรม Python พร้อมการรวม pytest
  • กระทำล่วงหน้า: กระทำ git hooks ล่วงหน้าที่ทำให้ชีวิตของคุณง่ายขึ้น
  • Markdown: แทนที่จะใช้ reStructuredText Markdown จะถูกใช้อย่างสม่ำเสมอสำหรับไฟล์ข้อความทั้งหมด
  • EditorConfig: รักษารูปแบบการเขียนโค้ดที่สอดคล้องกันสำหรับนักพัฒนาหลายคน
  • src-layout: แพ็คเกจ Python จริงถูกเก็บไว้ภายใต้โฟลเดอร์ src เพื่อหลีกเลี่ยงข้อผิดพลาดทั่วไปมากมาย

- เริ่มต้นอย่างรวดเร็ว

สร้างโครงการ:

โปรเจ็กต์นี้จะใช้ pipx เพื่อติดตั้ง hatch ในสภาพแวดล้อมที่ห่างไกล ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้ง pipx ก่อนที่จะรันคำสั่งต่อไปนี้ 

cookiecutter https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

เครื่องกำเนิดไฟฟ้าจะเรียก hatch env create & git init โดยอัตโนมัติในตอนท้าย

จากนั้น เพื่อ GitHub Actions pipelines ทำงานได้อย่างถูกต้อง คุณควร:

  • เปิดใช้งานพื้นที่เก็บข้อมูล GitHub ใน Codecov
  • ตั้งค่า CODECOV_TOKEN ในความลับของพื้นที่เก็บข้อมูล GitHub ของคุณ คุณสามารถค้นหาได้ในการตั้งค่า Codecov ของโครงการที่เกี่ยวข้อง
  • เปิดใช้งาน GitHub Pages โดยใช้แหล่งที่มา GitHub Actions
  • ตัวเลือกในการเผยแพร่ไปยัง Test PyPI สำหรับการทดสอบ
  • กำหนดค่าวิธีการผู้เผยแพร่ที่เชื่อถือได้บน PyPI: เป็นวิธีที่ทันสมัยและปลอดภัยในการพุชแพ็คเกจของคุณไปที่ PyPI

ด้วยความกระวนกระวายใจ

cruft เป็นเลเยอร์เหนือ Cookiecutter ที่ให้คุณอัปเดตโปรเจ็กต์ของคุณจากเทมเพลตหลังจากที่ถูกสร้างขึ้นแล้ว 

cruft create https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

สาธิต

ใบอนุญาต

โครงการนี้ได้รับอนุญาตภายใต้เงื่อนไขของใบอนุญาต MIT

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด