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

Uploaded Source

Built Distribution

sheraf-0.5.6-py3-none-any.whl (62.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sheraf-0.5.6.tar.gz
Algorithm Hash digest
SHA256 ceb9998f1559d3d5276490320ef9ef34964adf9c523bd35bf1e6b7c373f492bd
MD5 c707d2ff055f266d455c32a87bdf4045
BLAKE2b-256 a9bbde378ae59f281603c76043914c34625a28e0ec38828f810a89e2adcdeb29

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sheraf-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 32d84ff81838e54884f20213bd10289625444b5524d69156257047881875b463
MD5 a9c3136e2a107a4953c619ac20431b6d
BLAKE2b-256 0e9a463d4d6f14bbec0cac1f84f4c25cc7ba4e0f8e902aef018f23ce03436b36

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