https://github.com/picnicsupermarket/diepvries

The Picnic Data Vault framework.
https://github.com/picnicsupermarket/diepvries

data-vault python snowflake sql

Last synced: 3 days ago
JSON representation

The Picnic Data Vault framework.

• Host: GitHub
• URL: https://github.com/picnicsupermarket/diepvries
• Owner: PicnicSupermarket
• License: mit
• Created: 2021-02-17T09:31:47.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-26T15:11:01.000Z (8 months ago)
• Last Synced: 2024-04-26T16:34:30.352Z (8 months ago)
• Topics: data-vault, python, snowflake, sql
• Language: Python
• Homepage: https://diepvries.picnic.tech
• Size: 1010 KB
• Stars: 124
• Watchers: 32
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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)



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).