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

Uploaded Source

Built Distribution

sheraf-0.5.24-py3-none-any.whl (65.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.24.tar.gz
  • Upload date:
  • Size: 54.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.15.11-arch2-1

File hashes

Hashes for sheraf-0.5.24.tar.gz
Algorithm Hash digest
SHA256 a0c0d2f7dfbca307383c10d3e763e15b56101fd384c5c15e89f2294d0f0d6256
MD5 755249aad4486b143de13341fd661854
BLAKE2b-256 b3ff0f191c3fc03e58c239eac76487083a573416264cf2e5ef8d6fcdc7a97640

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for sheraf-0.5.24-py3-none-any.whl
Algorithm Hash digest
SHA256 ea7e28e883823236321fbc4a27138fe1ebd173dadc8e175d64e98ee8e7ffdec1
MD5 40778acc3fdf8c1efdbb935e84a8bf2f
BLAKE2b-256 df699249877a5ed902070bd4d4d0a830b157e25b321fc20bf017cfc7f1ddea91

See more details on using hashes here.

Provenance

Supported by

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