Metadata-Version: 2.5
Name: crabpy_pyramid
Version: 3.0.0
Summary: Bindings for the CRABpy webservices and the Pyramid framework.
Project-URL: Repository, https://github.com/OnroerendErfgoed/crabpy_pyramid.git
Project-URL: Issues, https://github.com/OnroerendErfgoed/crabpy_pyramid/issues
Project-URL: Changelog, https://github.com/OnroerendErfgoed/crabpy_pyramid/blob/master/CHANGES.rst
Author-email: Flanders Heritage Agency <ict@onroerenderfgoed.be>
License: The MIT License (MIT)
        
        Copyright (c) 2014-2016 Onroerend Erfgoed
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
        the Software, and to permit persons to whom the Software is furnished to do so,
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Keywords: AGIV,CAPAKEY,CRAB,pyramid,web,wsgi
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Pyramid
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.11
Requires-Dist: crabpy>=1.5.1
Requires-Dist: pycountry>=23.12.11
Requires-Dist: pyramid>=2.1
Description-Content-Type: text/markdown

# crabpy_pyramid

Bindings for the crabpy library and the pyramid framework

[![pypi](https://badge.fury.io/py/crabpy_pyramid.png)](http://badge.fury.io/py/crabpy_pyramid)
[![docs](https://readthedocs.org/projects/crabpy-pyramid/badge/?version=latest)](https://readthedocs.org/projects/crabpy-pyramid/?badge=latest)
[![CI](https://github.com/OnroerendErfgoed/crabpy_pyramid/actions/workflows/backend.yaml/badge.svg)](https://github.com/OnroerendErfgoed/crabpy_pyramid/actions/workflows/backend.yaml)
[![coverage](https://coveralls.io/repos/OnroerendErfgoed/crabpy_pyramid/badge.png?branch=master)](https://coveralls.io/r/OnroerendErfgoed/crabpy_pyramid?branch=master)
[![pypi](https://badge.fury.io/py/crabpy_pyramid.png)](http://badge.fury.io/py/crabpy_pyramid)


# Development

## Local setup (mise)

This repo uses [mise](https://mise.jdx.dev/) to make the project setup as
simple as possible. From a fresh clone:

```sh
mise trust       # trust this config (depends on your mise settings)
mise install     # install all tools (python 3.11, uv, pre-commit)
mise run setup   # create .venv, install the dependencies and the pre-commit hooks
```

Daily use:

```sh
mise run test              # run the test suite
mise run test:integration  # also run the tests against the live APIs, like CI
mise run lint              # run flake8, like CI
mise run server            # local server on http://localhost:6543
```

Other tasks: `mise run lock` (recompute `uv.lock`), `mise run build` (wheel +
sdist) and `mise run cleanup` (remove everything `setup` created). `mise tasks`
lists them all.

## Dependencies

Dependencies are managed with [uv](https://docs.astral.sh/uv/) and declared in
`pyproject.toml`; `uv.lock` holds the full pinned resolution and is committed.

Install the library together with the dev dependencies in `.venv`:

```sh
uv sync
```

After changing dependencies in `pyproject.toml`, recompute the lock with
`uv lock` (add `--upgrade` to update everything to the latest allowed versions).

Run the tests and linting:

```sh
uv run pytest tests
uv run flake8
```

## Building the docs

More information about this library can be found in `docs`. The docs can be
built using [Sphinx](http://sphinx-doc.org).

```sh
uv run --with sphinx --with sphinxcontrib-httpdomain make -C docs html
```

## Build wheel or sdist

```sh
uv build
uv build --wheel
uv build --sdist
```
