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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sheraf-0.4.12.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.11-arch1-1

File hashes

Hashes for sheraf-0.4.12.tar.gz
Algorithm Hash digest
SHA256 5abcdde41befdc32ff3399a973ae6238295ee57ea1c6e898d2e5ae9305ff0bfe
MD5 2aaf45511d2df230a85ef793896b7f2d
BLAKE2b-256 8e82ff9b8470b12b0e33de29e7209b1821b0d48a4f71be13bea4a8035d86ee29

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sheraf-0.4.12-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.11-arch1-1

File hashes

Hashes for sheraf-0.4.12-py3-none-any.whl
Algorithm Hash digest
SHA256 0eb189feec5f4be6566d7a68bf8944ba10219e650c28c8c8e193fb7e097e6365
MD5 5a577acee98dc8e308d8429be2f7a23e
BLAKE2b-256 7ca93e019e7ace511c6bc8d96130813fa4632de6dbb26a774e6106801937d3d9

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page