s2v-client 0.3.0

Stream2Vault Client

Stream2Vault Client

The Stream2Vault generator client.

Installation

Install the client using pip:

pip install s2v-client

Usage

Make sure to have your credentials pointed at by the environment variable GOOGLE_APPLICATION_CREDENTIALS.

Prepare your vault model in a directory structure like this:

MY_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

Command Line

Using the CLI, you can have the S2V generator create the vault for you:

export S2V_GENERATE_URL=https://the-s2v-server
s2v generate -i MY_VAULT/ -o output/

The results have been written to the output/ directory.

Run s2v generate --help to learn more about possible options.

Library

The S2V client can also be embedded in your Python application:

import pathlib
from s2v.client import S2VClient

s2v_client = S2VClient.create("https://the-s2v-server")
input_dir = pathlib.PurePath("MY_VAULT")
output_dir = pathlib.PurePath("output")
s2v_client.generate(input_dir, output_dir)