นี่คือตัวอย่างโปรเจ็กต์ที่แสดงวิธีที่ดีมากในการจัดโครงสร้างโปรเจ็กต์ของคุณ:https://github.com/kennethreitz/samplemod โครงการนี้เกี่ยวกับการสร้างโมดูล "ตัวอย่าง" โครงสร้างไดเร็กทอรีมีลักษณะดังนี้:
README.rst LICENSE setup.py requirements.txt sample/__init__.py sample/core.py sample/helpers.py docs/conf.py docs/index.rst tests/test_basic.py tests/test_advanced.py
ไฟล์ README.rst:ไฟล์นี้ใช้สำหรับให้คำอธิบายสั้นๆ เกี่ยวกับโมดูล วิธีการตั้งค่า วิธีใช้งาน ฯลฯ
ใบอนุญาต: มีข้อความใบอนุญาตและการอ้างสิทธิ์ในลิขสิทธิ์
setup.py: เป็นคำตอบของ Python สำหรับตัวติดตั้งหลายแพลตฟอร์มและสร้างไฟล์ หากคุณคุ้นเคยกับการติดตั้งบรรทัดคำสั่ง ให้ทำการ &&make install แปลเป็น python setup.py build &&python setup.py install ดังนั้นจึงใช้ในการสร้างโครงการของคุณบนเครื่องผู้ใช้
requirements.txt: ไฟล์ข้อกำหนดของ Pip ควรระบุการพึ่งพาที่จำเป็นสำหรับการสนับสนุนโครงการ:การทดสอบ การสร้าง และการสร้างเอกสาร หากโปรเจ็กต์ของคุณไม่มีการพึ่งพาการพัฒนา หรือคุณต้องการตั้งค่าสภาพแวดล้อมการพัฒนาผ่าน setup.py ไฟล์นี้ก็ไม่จำเป็น
เอกสาร/: ไดเรกทอรีนี้มีเอกสารสำหรับโครงการของคุณ
การทดสอบ/: การทดสอบทั้งหมดของคุณควรอยู่ในไดเร็กทอรีนี้ ในขั้นต้น คุณจะมีไฟล์ทดสอบเพียงไฟล์เดียว เมื่อเริ่มโตขึ้น คุณสามารถจัดโครงสร้างการทดสอบได้เหมือนไดเรกทอรีโมดูล
ตัวอย่าง/: ไดเร็กทอรีนี้มีโค้ดโมดูลจริงของคุณ หากโมดูลของคุณมีไฟล์เพียงไฟล์เดียว คุณสามารถวางไว้ในรูทของที่เก็บของคุณได้โดยตรงในชื่อ sample.py ไลบรารีของคุณไม่อยู่ในไดเร็กทอรีย่อย src หรือ python ที่คลุมเครือ ซึ่งจะมีไฟล์ __init__.py หากคุณต้องการให้โมดูลนี้อยู่ภายในแพ็คเกจ
