template package importable

ภาพรวม

นี่คือเทมเพลตแพ็คเกจที่เราใช้ภายในเมื่อสร้างแพ็คเกจที่นำเข้าจาก Python ใหม่ มันมีฟังก์ชั่นพื้นฐานและเวิร์กโฟลว์ทั้งหมดที่จำเป็นในการสร้างสร้างและเผยแพร่แพ็คเกจใหม่ให้กับ PYPI

เทมเพลตแพ็คเกจนี้ไม่ได้ให้ฟังก์ชั่น CLI ใด ๆ แต่ถูกออกแบบมาเพื่อสร้างแพ็คเกจที่นำเข้ามาแทน

เราตัดสินใจที่จะให้สิ่งนี้พร้อมกับเครื่องมืออื่น ๆ ของเราเพื่อให้ผู้คนใช้จุดเริ่มต้นที่ได้รับการออกแบบมาอย่างดีเมื่อสร้างเครื่องมือของตัวเอง

นอกจากนี้เรายังมีเทมเพลตอื่น ๆ อีก 2 รายการที่เราใช้

• โครงการ Python เทมเพลต
• แพ็คเกจเทมเพลต CLI

คุณสมบัติ

• สถาปัตยกรรมแบบแยกส่วน : จัดระเบียบรหัสของคุณเป็นโมดูลเพื่อการบำรุงรักษาที่ดีขึ้น
• ข้อยกเว้นที่กำหนดเอง : ตัวอย่างพื้นฐานสำหรับการใช้ข้อยกเว้นที่กำหนดเองสำหรับการจัดการข้อผิดพลาดเฉพาะ
• ตัวอย่างการทดสอบ : ตัวอย่างพื้นฐานสำหรับการเขียนการทดสอบ pytest สำหรับแพ็คเกจของคุณ

การติดตั้ง

ในการติดตั้งแพ็คเกจที่นำเข้าได้ให้โคลนที่เก็บและนำทางไปยังไดเรกทอรีโครงการ:

git clone https://github.com/DevelopersToolbox/template-package-importable.git
cd template-package-importable

ขอแนะนำให้ใช้สภาพแวดล้อมเสมือนจริงเพื่อจัดการการพึ่งพา คุณสามารถสร้างและเปิดใช้งานสภาพแวดล้อมเสมือนจริงโดยใช้คำสั่งต่อไปนี้:

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

ติดตั้งการพึ่งพาที่ต้องการ:

pip install -r requirements.txt

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

โครงการจัดขึ้นดังนี้:

template-package-importable/
├── wolfsoftware/
│   └── template_package_importable/
│       ├── __init__.py
│       ├── exceptions.py
│       └── functions.py
├── tests/
│   ├── __init__.py
│   └── test_template_package_importable.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_importable : มีโมดูลหลักของแอปพลิเคชัน
  • exceptions.py : จัดการข้อยกเว้นที่กำหนดเอง
  • functions.py : กำหนดฟังก์ชันตัวอย่าง (สำหรับการทดสอบ)
• tests : สถานที่ที่ทดสอบ pytest ตั้งอยู่
  • test_template_package_importable.py : การทดสอบเฉพาะที่จะเรียกใช้
• setup.py : การกำหนดค่าแพ็คเกจ
• requirements.txt : แสดงรายการการพึ่งพาที่จำเป็นสำหรับโครงการ
• README.md : ไฟล์ที่คุณกำลังอ่านอยู่