A versatile ZODB abstraction layer
sheraf is a wrapper library around ZODB that provides models management and indexation. It aims to make the use of ZODB simple by providing ready-to-use tools and explicit tools. sheraf is currently compatible with ZODB 5 and python 3.6+.
You can expect sheraf to:
- Do few things, but do them right;
- Be simple enough so beginners can do a lot with a few lines;
- Be powerful enough and tunable for python experts;
- Have a simple and expressive code, that allows you to hack it if needed.
Installation
sheraf is compatible with Python 3.6+
poetry add sheraf
# or
pip install sheraf
If you need pytest fixtures for your project check out pytest-sheraf. There are also sheraf fixtures for unittest.
pip install pytest-sheraf
Contributing
Bug reports and pull requests are highly encouraged!
- Test some code :
poetry run pytestandpoetry run tox - Format code :
black - Generate documentation :
poetry run tox -e doc
Documentation
You can build it with the following commands, or read it on readthedocs.
poetry run tox -e doc
open build/sphinx/html/index.html
Development installation
sheraf use poetry as its main build tool. Do not hesitate to check the documentation.
poetry install --extras all
5 maintainers
Release files for sheraf 0.5.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sheraf-0.5.6.tar.gz | 51.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sheraf-0.5.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 113.8 kB
Release files / sheraf-0.5.6.tar.gz
| Download URL | sheraf-0.5.6.tar.gz |
|---|---|
| Size | 51.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ceb9998f1559d3d5276490320ef9ef34964adf9c523bd35bf1e6b7c373f492bd
|
|
BLAKE2b-256 checksum How to use checksums |
a9bbde378ae59f281603c76043914c34625a28e0ec38828f810a89e2adcdeb29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.7 CPython/3.9.6 Linux/5.12.14-arch1-1
|
Release files / sheraf-0.5.6-py3-none-any.whl
| Download URL | sheraf-0.5.6-py3-none-any.whl |
|---|---|
| Size | 62.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
32d84ff81838e54884f20213bd10289625444b5524d69156257047881875b463
|
|
BLAKE2b-256 checksum How to use checksums |
0e9a463d4d6f14bbec0cac1f84f4c25cc7ba4e0f8e902aef018f23ce03436b36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.7 CPython/3.9.6 Linux/5.12.14-arch1-1
|
