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

Uploaded Source

Built Distribution

sheraf-0.4.16-py3-none-any.whl (59.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.4.16.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.14-arch1-1

File hashes

Hashes for sheraf-0.4.16.tar.gz
Algorithm Hash digest
SHA256 14543c96119df08b94d0f6cf411a414f9df6167aa15d5f8c51fa20b0a73fa95c
MD5 0de845861eaf491ee6736c35cd3934a9
BLAKE2b-256 61dc0e3e95ec53327b77444b23a5caebe95c10c440944010d19fcbcf3b201a34

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sheraf-0.4.16-py3-none-any.whl
Algorithm Hash digest
SHA256 de294845ec0a01bae765c5b93763cc47bb2bc9057b3ca1806e88c505756b3985
MD5 4cf5c51037786d654ac39ae8a6dd34a7
BLAKE2b-256 fe85a2a3c595615b11a5df28704f0acb8003661f861aaeca37a0963b227f1834

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