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

Uploaded Source

Built Distribution

sheraf-0.4.11-py3-none-any.whl (59.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.4.11.tar.gz
  • Upload date:
  • Size: 49.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.9.2 Linux/5.11.12-arch1-1

File hashes

Hashes for sheraf-0.4.11.tar.gz
Algorithm Hash digest
SHA256 b7d23a1d76bf000df59027095919c31538b29221eb776dadd6c4e798d1027156
MD5 220ca16df0c667f602f82f2f199488ea
BLAKE2b-256 3f8c9394600d2bacd2b6bdb6dafbe5f883741f730743a5ef86e0e3f8e47bfb88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sheraf-0.4.11-py3-none-any.whl
  • Upload date:
  • Size: 59.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.9.2 Linux/5.11.12-arch1-1

File hashes

Hashes for sheraf-0.4.11-py3-none-any.whl
Algorithm Hash digest
SHA256 24d488190f6429d76131e41bfb179328a09e9a0fe097d25ecbfae750caa5783f
MD5 feb9f2448e5f9382dcd719c624b538c7
BLAKE2b-256 dbbe657a7ff5b228e7cab9f3fe67cb85b2b7d958427231d0b006d7bc32c107d6

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