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

Uploaded Source

Built Distribution

sheraf-0.5.13-py3-none-any.whl (63.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.13.tar.gz
  • Upload date:
  • Size: 53.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.13.7-arch1-1

File hashes

Hashes for sheraf-0.5.13.tar.gz
Algorithm Hash digest
SHA256 7f3f5dbb9922afb4c1967d638671978e2932cf1a29c0062a71b577a80c9f784f
MD5 3effb7a116d182a902f206bf04a8ce59
BLAKE2b-256 22d14c7f915f84edcf92577e4d6defec6d36cb3ded9ebc35403929042142cab7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sheraf-0.5.13-py3-none-any.whl
  • Upload date:
  • Size: 63.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.13.7-arch1-1

File hashes

Hashes for sheraf-0.5.13-py3-none-any.whl
Algorithm Hash digest
SHA256 fe826d6fe85cb98d430d1d515340fe21b27b26d99a86806e03cb3e739718893e
MD5 e7c14c8a28530bfc0a0b17aced1c6c9a
BLAKE2b-256 e79bc6923b4409c2e3aff1f9eb8b8a6e7b29e31721a94d9106a15bb31fbe0777

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