Versatile ZODB abstraction layer
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sheraf-0.4.4.tar.gz.
File metadata
- Download URL: sheraf-0.4.4.tar.gz
- Upload date:
- Size: 47.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.2 Linux/5.11.1-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b1358ac751ba9fdfebb3196409e875446df78d39b5e933b357f35ff3d236302c |
|
| MD5 | 94d5e725b888b0eb0f4ccaf11f3c30bf |
|
| BLAKE2b-256 | 986fbc32eaa99ffce22af3eb6bdf63e51a8f3fb62388231be256fad5a22d0b47 |
Provenance
File details
Details for the file sheraf-0.4.4-py3-none-any.whl.
File metadata
- Download URL: sheraf-0.4.4-py3-none-any.whl
- Upload date:
- Size: 57.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.2 Linux/5.11.1-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2b19a3fbac285249fe590bac5d3a8dd79f15ecd83f1c687523e7ea3d95e5257c |
|
| MD5 | e88a55e8fd609a6e112a8aeda3d32376 |
|
| BLAKE2b-256 | 3f437f945745e41b6e5ba33e223f65e48c45d1ab60776b3154335b3fbb47e9b9 |
