Versatile ZODB abstraction layer

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for azmeuk from gravatar.com azmeuk Avatar for emillumine from gravatar.com emillumine Avatar for LoanR from gravatar.com LoanR Avatar for sblondon from gravatar.com sblondon Avatar for Yaal from gravatar.com Yaal

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Yaal team
  • Maintainer: Éloi Rivard
  • Tags zodb, orm
  • Requires: Python >=3.6, <4
Classifiers
Report project as malware

Project description

A versatile ZODB abstraction layer

sheraf is an overlay over ZODB. It provides a high level interface to save and read your data.

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

The documentation is hosted here.

Contributing

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

Documentation

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page