crabpy_pyramid

craby_pyramid

Reliures pour la bibliothèque Craby et le cadre pyramidal

Développement

Construire les documents

Plus d'informations sur cette bibliothèque peuvent être trouvées dans docs . Les documents peuvent être construits à l'aide de Sphinx <http://sphinx-doc.org> _.

Veuillez vous assurer que vous avez installé Sphinx dans le même environnement où Crabpy_pyramid est présent.

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

Construire une roue ou un sdist

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

Travailler avec pip-compile / pip-sync

Docs complet: https://pip-tools.readthedocs.io/en/latest/

Pour commencer, installez d'abord Pip-tools:

pip install pip-tools

UV (facultatif)

Vous pouvez également utiliser uv et pour le reste de la lecture ReadMe Remplacez pip , pip-compile ou pip-sync par uv pip , uv pip compile et uv pip sync .

uv est un remplacement très rapide pour Pip-toools. C'est facultatif, mais peut gagner beaucoup de temps.

pip install uv

Installation des exigences: pip-sync

Remarque, pip-sync désinstalle également tout, du VirtualEnv qui n'y appartient pas selon le fichier des exigences. Cela inclut le projet lui-même. Vous devrez à nouveau installer crabpy_pyramid après pip-sync . Étant donné que le fichier d'exigences de PIP-Sync est toujours un fichier d'exigences normal, vous pouvez également utiliser pip install -r pour installer toutes les bibliothèques définies. Cela ne nettoiera pas votre VirtualEnv et ne désinstallera pas d'autres bibliothèques.

Les fichiers d'exigences compilés sont fabriqués dans un environnement 3.11.

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

requirements-dev.txt contient toutes les bibliothèques sans cesse pour les tests et le développement.

requirements.txt ne contient que les bibliothèques nécessaires pour l'exécution de la bibliothèque.

Exigences de mise à jour: 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 "