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

Installation

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

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.5.30.tar.gz (55.1 kB view details)

Uploaded Source

Built Distribution

sheraf-0.5.30-py3-none-any.whl (65.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.30.tar.gz
  • Upload date:
  • Size: 55.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.18.5-arch1-1

File hashes

Hashes for sheraf-0.5.30.tar.gz
Algorithm Hash digest
SHA256 a56c6256fcd8b2f6c131db2df1dee707fa4f0cc8f889cd28ae8b8a0e93799f60
MD5 b0619f8caece4b2e0e6c2f38296b8ebd
BLAKE2b-256 08e6a84e6fb3606ed643d0633e6f367fae5441d83c9b986f913a50b18bd04a6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sheraf-0.5.30-py3-none-any.whl
  • Upload date:
  • Size: 65.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.18.5-arch1-1

File hashes

Hashes for sheraf-0.5.30-py3-none-any.whl
Algorithm Hash digest
SHA256 a4b4175179fe29d75688c07ddd0b2765488add8e5ba76fda3f8ddd871bec67dc
MD5 68aea8ccbcbbb413b9ee326cc62ecfc4
BLAKE2b-256 e8a93f373aeadcb999a6ab8e70681ec025a15911ce6f7733d6d009d14cc6acc4

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