Introduction

Stream2Vault package is a client application designed and built to streamline generation of the data vault objects available as a python package. The easiest way to install Stream2Vault package is via uv by astral. uv takes care of any dependencies and correct python versioning related to s2v-client making it our prefered choice for a smooth installation and upgrade process.

Prerequisites: Installing via uv python packaging

Follow the instructions given for the installation of uv by astral.

Prior continuation, verify uv is succesfully installed as stated in uv's instructions

uv tool install s2v-client
# updates required $PATH variables
uv tool update-shell

tip

It is also possible to install the Stream2Vault client via PyPi as an alternative to uv.

Remark: The Stream2Vault client package officially requires Python 3.12 - Issues related to the usage of any other Python version are not under warranty. 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 and has been set up for cross-tenant access with the Stream2Vault authentication service.

Once the cross-tenancy trust configuration is in place by your Administrator, 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.

warning

Please make sure to use a correct login account associated with the configuration file.

E.g. when issued an authentification json for the organization reeeliance while selecting on the login a different organization, any subsequent validations and generations will fail.

Please logout/login and choose a matching authentification

s2v logout
s2v login -c my_auth_config.json

That's it!

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