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.7+.

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.

sheraf is compatible with Python 3.7+

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

Bug reports and pull requests are highly encouraged!

• Test some code : poetry run pytest and poetry run tox
• Format code : black
• Generate documentation : poetry run tox -e doc

You can build it with the following commands, or read it on readthedocs.

poetry run tox -e doc
open build/sphinx/html/index.html

sheraf use poetry as its main build tool. Do not hesitate to check the documentation.

poetry install --extras all