Name | diepvries JSON |
Version |
1.0.1
JSON |
| download |
home_page | None |
Summary | diepvries - Picnic Data Vault framework |
upload_time | 2024-06-11 15:52:32 |
maintainer | None |
docs_url | None |
author | Picnic Technologies |
requires_python | >=3.8 |
license | MIT License Copyright (c) 2019-2021 Picnic Technologies BV Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
keywords |
data
vault
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# diepvries
[![PyPI version shields.io](https://img.shields.io/pypi/v/diepvries.svg)](https://pypi.python.org/pypi/diepvries/)
[![PyPI license](https://img.shields.io/pypi/l/diepvries.svg)](https://pypi.python.org/pypi/diepvries/)
[![Build](https://img.shields.io/github/actions/workflow/status/PicnicSupermarket/diepvries/pypi-build-and-deploy.yml)](https://github.com/PicnicSupermarket/diepvries/actions)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
<img src="doc/static/diepvries.svg" alt="diepvries logo" width=200>
Welcome to `diepvries`, a Python library to generate
[Data Vault](https://en.wikipedia.org/wiki/Data_vault_modeling) SQL statements.
## What does it do?
`diepvries` takes as input a Data Vault model (a list of hubs, links and satellites tables),
and generates SQL statements to load data in those tables. For that purpose, it relies
on naming conventions for tables and columns. There are 2 ways to feed a Data Vault
model to `diepvries`:
- Either declaratively, by enumerating tables and columns;
- Or automatically, by building these structures using the database metadata.
At the moment, `diepvries` is only compatible with
[Snowflake](https://www.snowflake.com/).
`diepvries` works with Python 3.8, 3.9, and 3.10.
## Getting started
`diepvries` is distributed as a Python wheel on PyPI. In a virtual environment, you can
grab the latest version by running:
```shell
pip install diepvries
```
and in a Python console:
```python3
from diepvries.hub import Hub
help(Hub)
```
If you see the help page for the `Hub` class, you're all set! :rocket:
## Continue the journey
The best way to start using `diepvries` is by reading
[its documentation website](https://diepvries.picnic.tech). You'll find a tutorial, a
list of naming conventions, and more!
## Contributing
Want to fix a bug, improve the docs, or add a new feature? That's awesome! Please read
the [contributing document](https://github.com/PicnicSupermarket/diepvries/blob/master/CONTRIBUTING.md).
## Changelog
You can find the changelog of this package in
[`CHANGELOG.md`](https://github.com/PicnicSupermarket/diepvries/blob/master/CHANGELOG.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "diepvries",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "data vault",
"author": "Picnic Technologies",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e0/2e/14d8e3a98a38e1e4008c84cc0e1e3ddf212f749c35c76bd41d0bab384958/diepvries-1.0.1.tar.gz",
"platform": null,
"description": "# diepvries\n\n[![PyPI version shields.io](https://img.shields.io/pypi/v/diepvries.svg)](https://pypi.python.org/pypi/diepvries/)\n[![PyPI license](https://img.shields.io/pypi/l/diepvries.svg)](https://pypi.python.org/pypi/diepvries/)\n[![Build](https://img.shields.io/github/actions/workflow/status/PicnicSupermarket/diepvries/pypi-build-and-deploy.yml)](https://github.com/PicnicSupermarket/diepvries/actions)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)\n\n<img src=\"doc/static/diepvries.svg\" alt=\"diepvries logo\" width=200>\n\nWelcome to `diepvries`, a Python library to generate\n[Data Vault](https://en.wikipedia.org/wiki/Data_vault_modeling) SQL statements.\n\n## What does it do?\n\n`diepvries` takes as input a Data Vault model (a list of hubs, links and satellites tables),\nand generates SQL statements to load data in those tables. For that purpose, it relies\non naming conventions for tables and columns. There are 2 ways to feed a Data Vault\nmodel to `diepvries`:\n\n- Either declaratively, by enumerating tables and columns;\n- Or automatically, by building these structures using the database metadata.\n\nAt the moment, `diepvries` is only compatible with\n[Snowflake](https://www.snowflake.com/).\n\n`diepvries` works with Python 3.8, 3.9, and 3.10.\n\n## Getting started\n\n`diepvries` is distributed as a Python wheel on PyPI. In a virtual environment, you can\ngrab the latest version by running:\n\n```shell\npip install diepvries\n```\n\nand in a Python console:\n\n```python3\nfrom diepvries.hub import Hub\nhelp(Hub)\n```\n\nIf you see the help page for the `Hub` class, you're all set! :rocket:\n\n## Continue the journey\n\nThe best way to start using `diepvries` is by reading\n[its documentation website](https://diepvries.picnic.tech). You'll find a tutorial, a\nlist of naming conventions, and more!\n\n## Contributing\n\nWant to fix a bug, improve the docs, or add a new feature? That's awesome! Please read\nthe [contributing document](https://github.com/PicnicSupermarket/diepvries/blob/master/CONTRIBUTING.md).\n\n## Changelog\n\nYou can find the changelog of this package in\n[`CHANGELOG.md`](https://github.com/PicnicSupermarket/diepvries/blob/master/CHANGELOG.md).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019-2021 Picnic Technologies BV Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "diepvries - Picnic Data Vault framework",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://diepvries.picnic.tech/",
"Issue Tracker": "https://github.com/PicnicSupermarket/diepvries/issues",
"Source Code": "https://github.com/PicnicSupermarket/diepvries"
},
"split_keywords": [
"data",
"vault"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "641899673dbf5c4e1b57c5b05db6523a0f7e06be3d76d358253edcf86bdad268",
"md5": "aea4d26157ec6bb00a1d85203147a8d5",
"sha256": "eb03594227df63692c51e13c9ed4e1ae9624e7e2cd8535622ada6caa74ecb31f"
},
"downloads": -1,
"filename": "diepvries-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aea4d26157ec6bb00a1d85203147a8d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32852,
"upload_time": "2024-06-11T15:52:17",
"upload_time_iso_8601": "2024-06-11T15:52:17.560382Z",
"url": "https://files.pythonhosted.org/packages/64/18/99673dbf5c4e1b57c5b05db6523a0f7e06be3d76d358253edcf86bdad268/diepvries-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e02e14d8e3a98a38e1e4008c84cc0e1e3ddf212f749c35c76bd41d0bab384958",
"md5": "c9903c59b65351442b802fa448f4a357",
"sha256": "f769c3bcfb78cf9c596645546e38d99a4e94e9a4ab9d622c01f35e356307b1f2"
},
"downloads": -1,
"filename": "diepvries-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c9903c59b65351442b802fa448f4a357",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 100922,
"upload_time": "2024-06-11T15:52:32",
"upload_time_iso_8601": "2024-06-11T15:52:32.859053Z",
"url": "https://files.pythonhosted.org/packages/e0/2e/14d8e3a98a38e1e4008c84cc0e1e3ddf212f749c35c76bd41d0bab384958/diepvries-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 15:52:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PicnicSupermarket",
"github_project": "diepvries",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "diepvries"
}