Skip to main content

Introduction

Stream2Vault package is a client application designed and built to streamline generation of the data vault objects. The easiest way to install Stream2Vault package is from the PyPi repository.

Python version support​

Officially Python 3.12.

Installing from PyPi​

Stream2Vault can be installed from PyPi.

pip install s2v-client
tip

We recommend setting up a virtual environment with correct version of Python and installing the package within it. Please see this guide on setting up a virtual environment with PyPi.

Authentication​

In order for the client package to communicate with the Stream2Vault service, you must have an account/identity that is part of the organisation that has been set up for cross-tenant access with the Stream2Vault authentication service.

Once the cross-tenancy trust configuration is in place, you will receive the authentication configuration file which you will need to save with your project and and reference it when logging into the service.

s2v login -c my_auth_config.json

Running the above command will open up a browser prompting you to select an appropriate account for the login. Once authenticated you can close the browser.

Initialising your project​

The following is a recommended project structure for the Stream2Vault project. It includes a few examples of data vault assets.

my_data_vault
├── configuration
│   ├── data_vault_settings.yaml
│   ├── source_system_settings.yaml
│   └── tags
│       └── pii.yaml
├── dv_model
│   ├── HUBS
│   │   ├── HUB_BILLING.yaml
│   │   ├── HUB_COMPANY_CODE.yaml
│   │   ├── HUB_COMPANY.yaml
│   │   └── HUB_CUSTOMER.yaml
│   ├── LINKS
│   │   └── LND_L_BILLING_HEADER.yaml
│   ├── REFERENCES
│   │   └── REF_DUMMY.yaml
│   └── SATELLITES
│   │   └── LDS_example.yaml
└── sources
    └── information_schema.csv

You can run the following set of commands to initialise the project.

mkdir my_data_vault
cd my_data_vault
mkdir configuration configuration/tags
mkdir dv_model dv_model/HUBS dv_model/LINKS dv_model/REFERENCES dv_model/SATELLITES
mkdir sources

That's it!​

Thank you for installing the Stream2Vault client. You are now ready to start generating Data Vault objects.