# A versatile ZODB abstraction layer
sheraf is a wrapper library around [ZODB](https://www.zodb.org) 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.7+`.
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.7+
poetry add sheraf
# or
pip install sheraf
If you need pytest fixtures for your project check out [pytest-sheraf](https://gitlab.com/yaal/pytest-sheraf). There are also [sheraf fixtures for unittest](https://gitlab.com/yaal/unittest-sheraf).
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](https://sheraf.readthedocs.io/en/latest/).
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](https://python-poetry.org/docs/).
poetry install --extras all
Raw data
{
"_id": null,
"home_page": "https://sheraf.readthedocs.io/en/latest/",
"name": "sheraf",
"maintainer": "\u00c9loi Rivard",
"docs_url": null,
"requires_python": ">=3.7,<4",
"maintainer_email": "eloi@yaal.coop",
"keywords": "zodb,orm",
"author": "Yaal team",
"author_email": "contact@yaal.coop",
"download_url": "https://files.pythonhosted.org/packages/8b/96/9f715e2aef3d8c314b020423928b7a6ee7ac03ea5db4727a5186ca1d146b/sheraf-0.5.38.tar.gz",
"platform": null,
"description": "# A versatile ZODB abstraction layer\n\nsheraf is a wrapper library around [ZODB](https://www.zodb.org) 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.7+`.\n\nYou can expect sheraf to:\n\n- Do few things, but do them right;\n- Be simple enough so beginners can do a lot with a few lines;\n- Be powerful enough and tunable for python experts;\n- Have a simple and expressive code, that allows you to hack it if needed.\n\n## Installation\n\nsheraf is compatible with Python 3.7+\n\n poetry add sheraf\n # or\n pip install sheraf\n\nIf you need pytest fixtures for your project check out [pytest-sheraf](https://gitlab.com/yaal/pytest-sheraf). There are also [sheraf fixtures for unittest](https://gitlab.com/yaal/unittest-sheraf).\n\n pip install pytest-sheraf\n\n## Contributing\n\nBug reports and pull requests are highly encouraged!\n\n - Test some code : `poetry run pytest` and `poetry run tox`\n - Format code :\u00a0`black`\n - Generate documentation : `poetry run tox -e doc`\n\n## Documentation\n\nYou can build it with the following commands, or read it on [readthedocs](https://sheraf.readthedocs.io/en/latest/).\n\n poetry run tox -e doc\n open build/sphinx/html/index.html\n\n## Development installation\n\nsheraf use poetry as its main build tool. Do not hesitate to check [the documentation](https://python-poetry.org/docs/).\n\n poetry install --extras all\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Versatile ZODB abstraction layer",
"version": "0.5.38",
"project_urls": {
"Documentation": "https://sheraf.readthedocs.io/en/latest/",
"Homepage": "https://sheraf.readthedocs.io/en/latest/",
"Repository": "https://gitlab.com/yaal/sheraf"
},
"split_keywords": [
"zodb",
"orm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d0439311a3e755b80ca77c65c1bc02c7c69419f3671f56db4ac5cb6fe015f1a",
"md5": "72c16c3d93ad18b800217aafd571ed5f",
"sha256": "082b465e6acd33cfe596e88d3362ebd8b52a784e5b02ca87db1d618b2b609455"
},
"downloads": -1,
"filename": "sheraf-0.5.38-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72c16c3d93ad18b800217aafd571ed5f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4",
"size": 65930,
"upload_time": "2023-07-11T09:50:45",
"upload_time_iso_8601": "2023-07-11T09:50:45.273854Z",
"url": "https://files.pythonhosted.org/packages/6d/04/39311a3e755b80ca77c65c1bc02c7c69419f3671f56db4ac5cb6fe015f1a/sheraf-0.5.38-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b969f715e2aef3d8c314b020423928b7a6ee7ac03ea5db4727a5186ca1d146b",
"md5": "5c82d4e249125fa45c4c33e20dc5b126",
"sha256": "71ea79d33360d7249dff12e0174d49f5b256a657db286e4a7add305ee4ba1f58"
},
"downloads": -1,
"filename": "sheraf-0.5.38.tar.gz",
"has_sig": false,
"md5_digest": "5c82d4e249125fa45c4c33e20dc5b126",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4",
"size": 55483,
"upload_time": "2023-07-11T09:50:46",
"upload_time_iso_8601": "2023-07-11T09:50:46.834124Z",
"url": "https://files.pythonhosted.org/packages/8b/96/9f715e2aef3d8c314b020423928b7a6ee7ac03ea5db4727a5186ca1d146b/sheraf-0.5.38.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-11 09:50:46",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "yaal",
"gitlab_project": "sheraf",
"lcname": "sheraf"
}
JSON