crabpy_pyramid

crabpy_pyramid

Bindungen für die Krabbenbibliothek und das Pyramid -Framework

Entwicklung

Aufbau der Dokumente

Weitere Informationen zu dieser Bibliothek finden Sie in docs . Die Dokumente können mit Sphinx <http://sphinx-doc.org> _ erstellt werden.

Bitte stellen Sie sicher, dass Sie Sphinx in derselben Umgebung installiert haben, in der Crabpy_Pyramid vorhanden ist.

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

Rad oder SDIST bauen

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

Arbeiten Sie mit Pip-Compile / Pip-Sync

Vollständige Dokumente: https://pip-tools.readthedocs.io/en/latest/

Installieren Sie zunächst PIP-Tools: zuerst installieren:

pip install pip-tools

UV (optional)

Sie können auch uv und für den Rest des Readme-Ersatzes pip , pip-compile oder pip-sync per uv pip , uv pip compile und uv pip sync verwenden.

uv ist ein sehr schneller Ersatz für PIP-Tools. Es ist optional, kann aber viel Zeit sparen.

pip install uv

Anforderungen installieren: PIP-Sync

Hinweis, pip-sync deinstalliert auch alles vom Virtualenv, das nicht nach der Anforderungen Datei gehört. Dies schließt das Projekt selbst ein. Sie müssen crabpy_pyramid nach pip-sync erneut installieren. Da die Anforderungsdatei von PIP -Sync weiterhin eine normale Anforderungendatei ist, können Sie auch pip install -r verwenden, um alle darin definierten Bibliotheken zu installieren. Dadurch werden Ihre Virtualenv nicht bereinigt und andere Bibliotheken deinstalliert.

Die kompilierten Anforderungen Dateien werden in einer 3.11 -Umgebung erstellt.

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

requirements-dev.txt enthält alle Bibliotheken, die diejenigen für Tests und Entwicklung nicht sammeln.

requirements.txt enthält nur die erforderlichen Bibliotheken für das Ausführen der Bibliothek.

Aktualisieren Sie die Anforderungen: 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 "