| Name | crabpy-pyramid JSON |
| Version |
2.2.0
JSON |
| download |
| home_page | None |
| Summary | Bindings for the CRABpy webservices and the Pyramid framework. |
| upload_time | 2024-11-27 09:05:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.10 |
| 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. |
| keywords |
agiv
capakey
crab
pyramid
web
wsgi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# crabpy_pyramid
Bindings for the crabpy library and the pyramid framework
[](http://badge.fury.io/py/crabpy_pyramid)
[](https://readthedocs.org/projects/crabpy-pyramid/?badge=latest)
[](https://github.com/OnroerendErfgoed/crabpy_pyramid/actions/workflows/backend.yaml)
[](https://coveralls.io/r/OnroerendErfgoed/crabpy_pyramid?branch=master)
[](http://badge.fury.io/py/crabpy_pyramid)
# 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.
```sh
pip install sphinx sphinxcontrib-httpdomain
pip install -e .
cd docs
make html
```
## Build wheel or sdist
```sh
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:
```sh
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.
```sh
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.
```sh
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
```sh
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"
```
Raw data
{
"_id": null,
"home_page": null,
"name": "crabpy-pyramid",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "AGIV, CAPAKEY, CRAB, pyramid, web, wsgi",
"author": null,
"author_email": "Flanders Heritage Agency <ict@onroerenderfgoed.be>",
"download_url": "https://files.pythonhosted.org/packages/14/a5/be60418db1ab281a034a0ceecf9143df37f4219ca163c0946f6452d80de5/crabpy_pyramid-2.2.0.tar.gz",
"platform": null,
"description": "# crabpy_pyramid\n\nBindings for the crabpy library and the pyramid framework\n\n[](http://badge.fury.io/py/crabpy_pyramid)\n[](https://readthedocs.org/projects/crabpy-pyramid/?badge=latest)\n[](https://github.com/OnroerendErfgoed/crabpy_pyramid/actions/workflows/backend.yaml)\n[](https://coveralls.io/r/OnroerendErfgoed/crabpy_pyramid?branch=master)\n[](http://badge.fury.io/py/crabpy_pyramid)\n\n\n# Development\n## Building the docs\n\nMore information about this library can be found in `docs`. The docs can be \nbuilt using `Sphinx <http://sphinx-doc.org>`_.\n\nPlease make sure you have installed Sphinx in the same environment where \ncrabpy\\_pyramid is present.\n\n```sh\npip install sphinx sphinxcontrib-httpdomain\npip install -e .\ncd docs\nmake html\n```\n\n## Build wheel or sdist\n\n```sh\npip install hatch\nhatch build\nhatch build -t wheel\nhatch build -t sdist\n```\n\n\n## Work with pip-compile / pip-sync\n\nfull docs: https://pip-tools.readthedocs.io/en/latest/\n\nTo start, first install pip-tools: \n```sh\npip install pip-tools\n```\n\n### uv (optional)\n\nYou can also use `uv` and for the remainder of the readme replace `pip`, `pip-compile` or\n`pip-sync` by `uv pip`, `uv pip compile` and `uv pip sync`.\n\n`uv` is a very fast replacement for pip-toools. It's optional, but can save a lot of time.\n```sh\npip install uv\n```\n\n### Install requirements: pip-sync\n\nNote, `pip-sync` also uninstalls everything from the virtualenv which does not belong \nthere according to the requirements file. This includes the project itself. You will\nhave to install `crabpy_pyramid` again after `pip-sync`.\nSince the requirements file of pip-sync is still a normal requirements file you can also\nuse `pip install -r` to install all libraries defined in it. This will not cleanup your\nvirtualenv and uninstall other libraries.\n\nThe compiled requirements files are made in a 3.11 environment.\n```sh\npip-sync requirements-dev.txt\npip install -e .\n```\n`requirements-dev.txt` contains all libraries uncluding those for testing and development.\n\n`requirements.txt` contains only the necessary libraries for running the library.\n\n### Update requirements: pip-compile\n\n```sh\necho -e \"\\nStarting\"\nPIP_COMPILE_ARGS=\"-q --strip-extras --no-header --resolver=backtracking --no-emit-options pyproject.toml\"\npip-compile $PIP_COMPILE_ARGS -o requirements.txt;\necho \"requirements.txt done\"\npip-compile $PIP_COMPILE_ARGS --extra dev -o requirements-dev.txt;\necho \"requirements-dev.txt done\"\necho \"Finished\"\n```\n",
"bugtrack_url": null,
"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.",
"summary": "Bindings for the CRABpy webservices and the Pyramid framework.",
"version": "2.2.0",
"project_urls": {
"Changelog": "https://github.com/OnroerendErfgoed/crabpy_pyramid/blob/master/CHANGES.rst",
"Issues": "https://github.com/OnroerendErfgoed/crabpy_pyramid/issues",
"Repository": "https://github.com/OnroerendErfgoed/crabpy_pyramid.git"
},
"split_keywords": [
"agiv",
" capakey",
" crab",
" pyramid",
" web",
" wsgi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b2c95d6595ad67dc0d20ef8d53690f0bc328808ecb95fcfe965987ab88d2603",
"md5": "ccbed76553e89995e11bb60bfa6ce67d",
"sha256": "5e906a09e9a721c25e239044fa401846ddfa5b80989e14ffc83ab59939e7b8d7"
},
"downloads": -1,
"filename": "crabpy_pyramid-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ccbed76553e89995e11bb60bfa6ce67d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 16913,
"upload_time": "2024-11-27T09:05:50",
"upload_time_iso_8601": "2024-11-27T09:05:50.820410Z",
"url": "https://files.pythonhosted.org/packages/5b/2c/95d6595ad67dc0d20ef8d53690f0bc328808ecb95fcfe965987ab88d2603/crabpy_pyramid-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14a5be60418db1ab281a034a0ceecf9143df37f4219ca163c0946f6452d80de5",
"md5": "7424160aaeea0ecc8642749ec6bb4ce1",
"sha256": "8420a80bfae8dcfcf13b0a138d5f76e297a34960fa93db1e785ccaf8d1c9f342"
},
"downloads": -1,
"filename": "crabpy_pyramid-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "7424160aaeea0ecc8642749ec6bb4ce1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 35677,
"upload_time": "2024-11-27T09:05:52",
"upload_time_iso_8601": "2024-11-27T09:05:52.550820Z",
"url": "https://files.pythonhosted.org/packages/14/a5/be60418db1ab281a034a0ceecf9143df37f4219ca163c0946f6452d80de5/crabpy_pyramid-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 09:05:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OnroerendErfgoed",
"github_project": "crabpy_pyramid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "crabpy-pyramid"
}
