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

Uploaded Source

Built Distribution

sheraf-0.5.0-py3-none-any.whl (60.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.0.tar.gz
  • Upload date:
  • Size: 50.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.12.6-arch1-1

File hashes

Hashes for sheraf-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d1dba4130c685a6f6cfc2f32464f724af985c650af77f0c1cc46b3db4100321b
MD5 abf54d78c4efa730edc6d9f75b1da38b
BLAKE2b-256 4ad8aa07c730f2a2b80bcae0eacfbeb15a586738217c1afc630b82b51aa46d4e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sheraf-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fbd3bb4d5d135bea85dd16281cf6fd6b0de7af4541983cd543c6db5dff2810b3
MD5 3b868706f90d6ac051a599afd9c9f24c
BLAKE2b-256 cae8e5b0d2d4199da05bb28efa1148e0e423eee91c964c9317ba77450610f649

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