bootstrap python package

bootstrap-python-package

ที่เก็บเทมเพลตนี้ให้แผ่นหม้อต้มเพื่อสร้างแพ็คเกจ Python มันถูกกำหนดค่าด้วยคุณสมบัติทั้งหมดต่อไปนี้:

• ชุดทดสอบโดยใช้ Tox และ Pytest
• พิมพ์โดยใช้ mypy
• รูปแบบผ้าสำลีความปลอดภัยและรหัสโดยใช้ RUFF (ใช้สไตล์รหัสสีดำและกฎความปลอดภัยของโจร)
• การรวมเข้ากับ codecliate สำหรับคุณภาพรหัสและการตรวจสอบความครอบคลุม
• สนับสนุนท่อส่ง CI:
  • การทดสอบกับ Python หลายรุ่น
  • วางจำหน่ายใน PYPI
  • เอกสารหน้า GitHub โดยใช้ mkdocs
• การกำหนดค่าพื้นฐาน Pycharm

วิธีใช้เทมเพลตที่เก็บนี้เพื่อสร้างแพ็คเกจใหม่

• สร้างที่เก็บ GitHub ของคุณโดยใช้เทมเพลตนี้ (สีเขียวขนาดใหญ่ Use this template )
• เปลี่ยนชื่อไดเรกทอรี bootstrap_python_package
• ค้นหาและแทนที่สิ่งที่เกิดขึ้นทั้งหมดของ bootstrap-python-package และ bootstrap_python_package
• กำหนดค่าผู้เผยแพร่ที่เชื่อถือได้บน PYPI โดยใช้ค่าต่อไปนี้:
  • ชื่อโครงการ PYPI: ชื่อที่เก็บ GitHub (ในกรณีนี้ bootstrap-python-package )
  • เจ้าของ: เจ้าของที่เก็บ GitHub (ในกรณีนี้ febus982 )
  • ชื่อที่เก็บ: ชื่อที่เก็บ gitHub (ในกรณีนี้ bootstrap-python-package )
  • ชื่อเวิร์กโฟลว์: release.yml
• สร้างความลับการกระทำของ GitHub ชื่อ CODECLIMATE_REPORTER_ID (ที่ URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ) ที่มีรหัสผู้ตรวจสอบ https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ) หากคุณไม่ต้องการใช้ codeclimate เพียงลบ workflows/python-quality.yml
• อัปเดตป้ายใน README.md ! (ตรวจสอบ Shields.io สำหรับป้ายพิเศษ)
• อัปเดตโปรไฟล์ลิขสิทธิ์ Pycharm ในการตั้งค่า IDE: Editor | ลิขสิทธิ์ โปรไฟล์ลิขสิทธิ์ (ถ้าคุณต้องการใช้)
• การตั้งค่าการพัฒนาท้องถิ่น:
  • โคลนที่เก็บ
  • ติดตั้งบทกวี pip install poetry
  • ติดตั้ง Dev Dependencies ด้วย make dev-dependencies
  • (ไม่บังคับ) ขอแนะนำอย่างยิ่งให้ติดตั้งล่วงหน้าและเรียกใช้ pre-commit install เพื่อให้การจัดรูปแบบและผ้าสำลีจะถูกดำเนินการโดยอัตโนมัติในระหว่าง git commit
• การตั้งค่าหน้า GitHub (ต้องการการตั้งค่าการพัฒนาในท้องถิ่น):
  • เอกสารประกอบการเริ่มต้น Branch poetry run mike deploy dev latest --update-aliases --push
  • กำหนดค่าหน้า gitHub เพื่อปรับใช้จากสาขา gh-pages (ที่ URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • เพิ่มสาขา main และ v*.*.* กฎแท็กลงในรายการ "การปรับใช้สาขาและแท็ก" ในสภาพแวดล้อม gh-pages (ที่ URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments )

สำคัญ: ที่เก็บได้รับการกำหนดค่าให้ปรับใช้กับที่เก็บ PYPI ทดสอบ ขอแนะนำอย่างยิ่งให้สร้างโครงการในที่เก็บ PYPI ทดสอบและทดสอบไปป์ไลน์การปรับใช้ เมื่อคุณมีความสุขกับผลลัพธ์ให้สร้างโครงการบนที่เก็บ PYPI อย่างเป็นทางการและลบบรรทัดที่ทำเครื่องหมายไว้ใน workflows/release.yml

การเปิดตัวแพ็คเกจ

การตั้งค่านี้ใช้บทกวี--มิก-รุ่น ซึ่งหมายความว่าไม่จำเป็นต้องส่งเวอร์ชันในรหัส แต่ไปป์ไลน์ CI จะอนุมานได้จากแท็ก GIT

หากต้องการเปิดตัวเวอร์ชันใหม่เพียงสร้างรีลีสใหม่และแท็กในที่เก็บ GitHub เพื่อ:

• สร้างและปรับใช้แพ็คเกจ Python เป็น PYPI
• สร้างและปรับใช้เอกสารเวอร์ชันใหม่ไปยังหน้า GitHub

สำคัญ: การกำหนดค่าเริ่มต้นต้องใช้ชื่อปล่อยและแท็กเพื่อติดตามการประชุม vX.XX (การกำหนดเวอร์ชันความหมายนำหน้าด้วยตัวพิมพ์เล็ก v ) มันจะเผยแพร่เวอร์ชันที่ถูกต้องบน PYPI โดยไม่ต้องใช้ v (เช่น v1.0.0 จะเผยแพร่ 1.0.0 )

รูปแบบนี้สามารถปรับแต่งได้อ้างอิงจากเอกสารบทกวี--ดูรุ่น

คำสั่งเพื่อการพัฒนา

คำสั่งทั่วไปทั้งหมดที่ใช้ในระหว่างการพัฒนาสามารถทำงานได้โดยใช้เป้าหมาย:

• make dev-dependencies : ติดตั้งข้อกำหนดของ Dev
• make update-dependencies : อัปเดตข้อกำหนดของ Dev
• make fix : Run Code Style และ Lint Automatic Fix (หากเป็นไปได้)
• make test : เรียกใช้ชุดทดสอบกับรุ่น Python ระบบ
• make check : เรียกใช้การทดสอบกับ Python เวอร์ชันที่มีอยู่ทั้งหมดรูปแบบรหัสและการตรวจสอบผ้าสำลี
• make type make format make lint make bandit : เรียกใช้เช็คที่เกี่ยวข้อง
• make docs : แสดงเว็บไซต์ mkdocs ในพื้นที่