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

Uploaded Source

Built Distribution

sheraf-0.5.20-py3-none-any.whl (64.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.20.tar.gz
  • Upload date:
  • Size: 54.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.15.2-arch1-1

File hashes

Hashes for sheraf-0.5.20.tar.gz
Algorithm Hash digest
SHA256 271cfb449a01fc3bda293df722d267da531356114f0f9ced00d0320d2678be0b
MD5 87a7c494566c6db874dd7672df727ff2
BLAKE2b-256 5d4d2bd92fe72c107bcb5c02b57ae72659351b91dbc7803941795c93cda21346

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sheraf-0.5.20-py3-none-any.whl
  • Upload date:
  • Size: 64.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.15.2-arch1-1

File hashes

Hashes for sheraf-0.5.20-py3-none-any.whl
Algorithm Hash digest
SHA256 fecf92657545d751d0c79427c1375f753acabbe845a3dfff21f79d6df03edb1b
MD5 a42cca38e9944ad2e9401cd696c8fb6a
BLAKE2b-256 16dae194b4b67301f90c1f7d2f5a661315dfa2fd29360039c9d0ff3f2b2bf0c5

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