crabpy_pyramid

crabpy_pyramid

روابط لمكتبة سرطان البحر وإطار الهرم

تطوير

بناء المستندات

يمكن العثور على مزيد من المعلومات حول هذه المكتبة في docs . يمكن بناء المستندات باستخدام Sphinx <http://sphinx-doc.org> _.

يرجى التأكد من أنك قمت بتثبيت sphinx في نفس البيئة حيث يوجد 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:

pip install pip-tools

الأشعة فوق البنفسجية (اختيارية)

يمكنك أيضًا استخدام uv وبما تبقى من README استبدال pip أو pip-compile أو pip-sync بواسطة uv pip و uv pip compile و uv pip sync .

uv هو بديل سريع للغاية ل pip-tools. إنه اختياري ، ولكن يمكن أن يوفر الكثير من الوقت.

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 "