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

Uploaded Source

Built Distribution

sheraf-0.5.29-py3-none-any.whl (65.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.29.tar.gz
  • Upload date:
  • Size: 54.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.15.13-arch1-1

File hashes

Hashes for sheraf-0.5.29.tar.gz
Algorithm Hash digest
SHA256 f69ebef37665c3d36a3f363305acb1491dbffa7ae834eb813365d3a539e71504
MD5 ae9b883c678fdfffefeaf1518a3718cb
BLAKE2b-256 bf9c3b1e1d32a5de87f5d8bb7c1ed01bbc6c32b1fa6b7df7ee982bc7b317891b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sheraf-0.5.29-py3-none-any.whl
  • Upload date:
  • Size: 65.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.15.13-arch1-1

File hashes

Hashes for sheraf-0.5.29-py3-none-any.whl
Algorithm Hash digest
SHA256 f698e8cece0be09175cdfe5c97d0e6f2c31123ccfdbf4f30c6ca43d41c247cd5
MD5 fd0471e48fa38d5b25b8872f1dfd4c3c
BLAKE2b-256 f8806a3f851b5d3556e7b071ade323ac3fec1284c1fb5ef6a3df43b6a4899368

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