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-Tools:

pip install pip-tools

УФ (необязательно)

Вы также можете использовать 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 для установки всех библиотек, определенных в нем. Это не очистит ваши виртуальные библиотеки и не удалит другие библиотеки.

Скомпилированные файлы требований выполняются в среде 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 "