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

Uploaded Source

Built Distribution

sheraf-0.5.8-py3-none-any.whl (62.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.8.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.13.4-arch2-1

File hashes

Hashes for sheraf-0.5.8.tar.gz
Algorithm Hash digest
SHA256 55af86842a8c145dda31a212c453f40a93a9c1e4178880af5347d2b061df2582
MD5 dd83db9c260caae5c047379b229151de
BLAKE2b-256 3b8babbec1c1f9fc1d1f9ceb5f16dcaac3b230cc2e6ca3558922e7486880d341

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sheraf-0.5.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a020bfcf14748b2fd09ce59672fe8c368c4f433695fbe637c495f95a0c78e9b8
MD5 a4ea9e3f4cc20271a76a93a8eb2c978c
BLAKE2b-256 fb88c4e2629a93b6dcbc165996e59c58a4ae995a8ed9b22e62efd63c6a18859a

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