pytemplates

โครงการของเรา: โครงการทำอะไร

ยินดีต้อนรับสู่ our_project

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

คู่มือการติดตั้ง

pip install our_project 

คุณสมบัติที่ใช้งานอยู่ในปัจจุบัน

our_project ในปัจจุบันทำดังต่อไปนี้:

• มี HelloWorld ชั้นฐานคลาส

• HelloWorld มีวิธี print_text ที่พิมพ์ข้อความที่ผู้ใช้จัดหา

• การกระทำของ GitHub เพื่อทดสอบการติดตั้งโครงการและเรียกใช้การทดสอบ

• การกระทำของ GitHub เพื่อเปิดตัวบน PYPI (ต้องเพิ่ม PYPI_USERNAME และ PYPI_PASSWORD เพื่อความลับที่เก็บ)

คุณสมบัติที่ต้องการความสนใจเพิ่มเติม

เราตั้งใจที่จะทำงานต่อไปนี้ในอนาคต:

• ทำให้ยุ่งยากน้อยลงในการเริ่มต้นเอกสารด้วย sphinx

การสร้างเอกสาร

โปรดแก้ไข docs/source/index.rst และ docs/source/modules.rst ตามที่ต้องการแล้วเรียกใช้:

./scripts/mkdocs.sh 

ข้างต้นถือว่าคุณอยู่ที่รากของ "our_project"

นอกจากนี้ยังลบ setup.rst , tests.rst , หากมีอยู่

มิฉะนั้นเรียกใช้และแก้ไขตามความจำเป็น

sphinx-quickstart

ขอบคุณ,

Nelsongon 22/10/2021

---

บันทึกสำคัญ

ที่เก็บนี้มีแม่แบบที่เป็นไปตามเวิร์กโฟลว์ทั่วไปสำหรับโครงการ python ใหม่

คำเตือน

เทมเพลตเหล่านี้ส่วนใหญ่มีวัตถุประสงค์เพื่อประหยัดเวลา อย่างไรก็ตาม IDE ที่ทันสมัยให้แม่แบบโครงการที่มีความเป็นผู้ใหญ่และมีความคิดเห็นน้อยกว่าเทมเพลตที่นี่

ที่เก็บนี้มีจุดประสงค์เพิ่มเติมในการอนุญาตให้นักพัฒนาใหม่ในการเขียนโปรแกรมเพื่อศึกษาโครงสร้างโครงการโดยใช้ตัวอย่างง่าย ๆ

สำหรับใบอนุญาตการทดสอบและเวิร์กโฟลว์ Gitignore ขอแนะนำให้สร้างสิ่งเหล่านี้โดยอัตโนมัติจาก IDE ที่เลือกหรือสำหรับไฟล์ .gitignore และใบอนุญาตผ่าน GitHub หรือ Gitlab

ยินดีที่ได้รับฟังจากคุณในกรณีที่มีคำถามและ/หรือข้อเสนอแนะ

---

ข้อจำกัดความรับผิดชอบ :

โครงการนี้ไม่ได้เกี่ยวข้องกับแพ็คเกจ pytemplates ที่มีชื่อคล้ายกันซึ่งทำสิ่งที่แตกต่างอย่างสิ้นเชิง ("pytemplates เป็นเครื่องยนต์เทมเพลต HTML ที่มีน้ำหนักเบาที่เขียนใน Python พร้อมรองรับการสืบทอดแม่แบบบล็อกแมโครบริบทและ Django")

ฉันต้องเรียนรู้เกี่ยวกับแพ็คเกจนี้เมื่อเพิ่มป้ายลงในไฟล์นี้