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

Uploaded Source

Built Distribution

sheraf-0.5.3-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.5.3.tar.gz
  • Upload date:
  • Size: 50.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.5 Linux/5.12.13-arch1-2

File hashes

Hashes for sheraf-0.5.3.tar.gz
Algorithm Hash digest
SHA256 2d118a036a728f0873676f6615e8b2b663919942c3288d6f725b4c3aaa639b18
MD5 6b8807ef58344a74b983ae92fc179725
BLAKE2b-256 2d69c797b5f5bc5bdb7b95c238b56ea7b7b110830c36d5b95aab4dbdf750d995

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sheraf-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 61.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.5 Linux/5.12.13-arch1-2

File hashes

Hashes for sheraf-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a2e78c6ab516eccd38b5c788de9294a441d6c911699a67d369284094c73ca068
MD5 6766dd93bd5d8e2b4eca81be88566506
BLAKE2b-256 85eb88f659556a60c2fc355b3815b578f4f585a139cb856ef01c69d5bc3c7531

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