p-mir / diepvries

The Picnic Data Vault framework.

diepvries

Welcome to diepvries, a Python library to generate Data Vault 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.

diepvries works with Python 3.8 and 3.9.

Getting started

diepvries is distributed as a Python wheel on PyPI. In a virtual environment, you can grab the latest version by running:

pip install diepvries

and in a Python console:

from diepvries.hub import Hub
help(Hub)

If you see the help page for the Hub class, you're all set! 🚀

Continue the journey

The best way to start using diepvries is by reading its documentation website. 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.

Changelog

You can find the changelog of this package in CHANGELOG.md.