Skip to main content

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 pytest and poetry 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

Project details


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

sheraf-0.4.18.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

sheraf-0.4.18-py3-none-any.whl (59.2 kB view details)

Uploaded Python 3

File details

Details for the file sheraf-0.4.18.tar.gz.

File metadata

  • Download URL: sheraf-0.4.18.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.3 Linux/5.11.15-arch1-2

File hashes

Hashes for sheraf-0.4.18.tar.gz
Algorithm Hash digest
SHA256 ca6a47d6c53cba79c0253583ef0add724fe34f52f1fbb9f1f6ca77a5a187528e
MD5 10d7a19af03fa4c57c8ea440b9164194
BLAKE2b-256 1211bcdf9538719f2a6334a9607380af8846fd67a1eedf73d4850f641a5915eb

See more details on using hashes here.

File details

Details for the file sheraf-0.4.18-py3-none-any.whl.

File metadata

  • Download URL: sheraf-0.4.18-py3-none-any.whl
  • Upload date:
  • Size: 59.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.3 Linux/5.11.15-arch1-2

File hashes

Hashes for sheraf-0.4.18-py3-none-any.whl
Algorithm Hash digest
SHA256 fc441e68e91b8223d909c2a3c26af7b3c1f1f5a55fd31ffa1d4bf04b59799af9
MD5 e4963d7f284910eab2d8cfa011a61f5b
BLAKE2b-256 bf3af81ab09c145e28183c77a07b80bf38476ae18be33dd534134657672dddcc

See more details on using hashes here.

Supported by

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