Skip to main content

Bindings for the CRABpy webservices and the Pyramid framework.

Project description

crabpy_pyramid

Bindings for the crabpy library and the pyramid framework

pypi docs CI coverage pypi

Development

Building the docs

More information about this library can be found in docs. The docs can be built using Sphinx <http://sphinx-doc.org>_.

Please make sure you have installed Sphinx in the same environment where crabpy_pyramid is present.

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

Build wheel or sdist

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

Work with pip-compile / pip-sync

full docs: https://pip-tools.readthedocs.io/en/latest/

To start, first install pip-tools:

pip install pip-tools

uv (optional)

You can also use uv and for the remainder of the readme replace pip, pip-compile or pip-sync by uv pip, uv pip compile and uv pip sync.

uv is a very fast replacement for pip-toools. It's optional, but can save a lot of time.

pip install uv

Install requirements: pip-sync

Note, pip-sync also uninstalls everything from the virtualenv which does not belong there according to the requirements file. This includes the project itself. You will have to install crabpy_pyramid again after pip-sync. Since the requirements file of pip-sync is still a normal requirements file you can also use pip install -r to install all libraries defined in it. This will not cleanup your virtualenv and uninstall other libraries.

The compiled requirements files are made in a 3.11 environment.

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

requirements-dev.txt contains all libraries uncluding those for testing and development.

requirements.txt contains only the necessary libraries for running the library.

Update requirements: 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"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crabpy_pyramid-2.2.0.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

crabpy_pyramid-2.2.0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file crabpy_pyramid-2.2.0.tar.gz.

File metadata

  • Download URL: crabpy_pyramid-2.2.0.tar.gz
  • Upload date:
  • Size: 35.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.20

File hashes

Hashes for crabpy_pyramid-2.2.0.tar.gz
Algorithm Hash digest
SHA256 8420a80bfae8dcfcf13b0a138d5f76e297a34960fa93db1e785ccaf8d1c9f342
MD5 7424160aaeea0ecc8642749ec6bb4ce1
BLAKE2b-256 14a5be60418db1ab281a034a0ceecf9143df37f4219ca163c0946f6452d80de5

See more details on using hashes here.

File details

Details for the file crabpy_pyramid-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: crabpy_pyramid-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.20

File hashes

Hashes for crabpy_pyramid-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e906a09e9a721c25e239044fa401846ddfa5b80989e14ffc83ab59939e7b8d7
MD5 ccbed76553e89995e11bb60bfa6ce67d
BLAKE2b-256 5b2c95d6595ad67dc0d20ef8d53690f0bc328808ecb95fcfe965987ab88d2603

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page