crabpy_pyramid

crabpy_pyramid

การผูกมัดสำหรับห้องสมุด Crabpy และเฟรมเวิร์กปิรามิด

การพัฒนา

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

ข้อมูลเพิ่มเติมเกี่ยวกับห้องสมุดนี้สามารถพบได้ใน docs เอกสารสามารถสร้างได้โดยใช้ Sphinx <http://sphinx-doc.org> _

โปรดตรวจสอบให้แน่ใจว่าคุณได้ติดตั้งสฟิงซ์ในสภาพแวดล้อมเดียวกันกับที่มี crabpy_pyramid อยู่

pip install sphinx sphinxcontrib-httpdomain
pip install -e .
cd docs
make html

สร้างล้อหรือ sdist

pip install hatch
hatch build
hatch build -t wheel
hatch build -t sdist

ทำงานกับ pip-compile / pip-sync

เอกสารเต็ม: https://pip-tools.readthedocs.io/en/latest/

ในการเริ่มต้นให้ติดตั้ง PIP-Tools ก่อน:

pip install pip-tools

UV (ไม่บังคับ)

นอกจากนี้คุณยังสามารถใช้ uv และส่วนที่เหลือของ readme แทนที่ pip , pip-compile หรือ pip-sync โดย uv pip , uv pip compile และ uv pip sync

uv เป็นการทดแทนที่รวดเร็วมากสำหรับ PIP-TOOOLS เป็นทางเลือก แต่สามารถประหยัดเวลาได้มาก

pip install uv

การติดตั้งข้อกำหนด: pip-sync

หมายเหตุ pip-sync ยังถอนการติดตั้งทุกอย่างจาก VirtualEnV ซึ่งไม่ได้อยู่ที่นั่นตามไฟล์ข้อกำหนด ซึ่งรวมถึงโครงการเอง คุณจะต้องติดตั้ง crabpy_pyramid อีกครั้งหลังจาก pip-sync เนื่องจากไฟล์ข้อกำหนดของ PIP -Sync ยังคงเป็นไฟล์ข้อกำหนดปกติคุณจึงสามารถใช้ pip install -r เพื่อติดตั้งไลบรารีทั้งหมดที่กำหนดไว้ในนั้น สิ่งนี้จะไม่ทำความสะอาด VirtualEnV และถอนการติดตั้งห้องสมุดอื่น ๆ ของคุณ

ไฟล์ข้อกำหนดที่รวบรวมได้ทำในสภาพแวดล้อม 3.11

pip-sync requirements-dev.txt
pip install -e .

requirements-dev.txt มีห้องสมุดทั้งหมดที่ไม่สามารถทดสอบสิ่งเหล่านี้สำหรับการทดสอบและการพัฒนา

requirements.txt มีเฉพาะไลบรารีที่จำเป็นสำหรับการรันไลบรารี

ข้อกำหนดอัปเดต: PIP Compile

 echo -e " nStarting "
PIP_COMPILE_ARGS= " -q --strip-extras --no-header --resolver=backtracking --no-emit-options pyproject.toml "
pip-compile $PIP_COMPILE_ARGS -o requirements.txt ;
echo " requirements.txt done "
pip-compile $PIP_COMPILE_ARGS --extra dev -o requirements-dev.txt ;
echo " requirements-dev.txt done "
echo " Finished "