| Name | s2v-client JSON |
| Version |
0.9.3
JSON |
| download |
| home_page | None |
| Summary | Stream2Vault Client |
| upload_time | 2024-12-05 12:13:06 |
| maintainer | None |
| docs_url | None |
| author | Reeeliance IM GmbH |
| requires_python | >=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Stream2Vault Client
The Stream2Vault generator client.
## Installation
Install the client using `pip`:
```shell
pip install s2v-client
```
## Usage
Authenticate the CLI with the S2V server using the auth configuration file belonging to your tenant:
```shell
s2v login -c my_auth_config.json
```
```
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:
```shell
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.
#### Setting up Shell Completion
The S2V CLI supports shell completion for Bash, Zsh and Fish.
For Bash, add this to your `~/.bashrc`:
```shell
eval "$(_S2V_COMPLETE=bash_source s2v)"
```
For Zsh, add this to your `~/.zshrc`:
```shell
eval "$(_S2V_COMPLETE=zsh_source s2v)"
```
For Fish, create a file named `~/.config/fish/completions/foo-bar.fish` with the following content:
```shell
env _S2V_COMPLETE=fish_source s2v | source
```
### Library
The S2V client can also be embedded in your Python application.
Using the auth configuration file directly assumes your application to run in an Azure environment.
```python
import pathlib
from s2v.client import S2VClient
from google.auth import external_account
credentials = external_account.Credentials.from_file("my_auth_config.json")
input_dir = pathlib.Path("MY_VAULT")
output_dir = pathlib.Path("output")
with S2VClient.create(credentials) as s2v_client:
s2v_client.generate(input_dir, output_dir)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "s2v-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Reeeliance IM GmbH",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# Stream2Vault Client\n\nThe Stream2Vault generator client.\n\n## Installation\n\nInstall the client using `pip`:\n\n```shell\npip install s2v-client\n```\n\n## Usage\n\nAuthenticate the CLI with the S2V server using the auth configuration file belonging to your tenant:\n\n```shell\ns2v login -c my_auth_config.json\n```\n\n```\nMY_VAULT\n\u251c\u2500\u2500 configuration\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 data_vault_settings.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 source_system_settings.yaml\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 tags\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 pii.yaml\n\u251c\u2500\u2500 dv_model\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 HUBS\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 HUB_BILLING.yaml\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 HUB_COMPANY_CODE.yaml\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 HUB_COMPANY.yaml\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 HUB_CUSTOMER.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 LINKS\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 LND_L_BILLING_HEADER.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 REFERENCES\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 REF_DUMMY.yaml\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 SATELLITES\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 LDS_example.yaml\n\u2514\u2500\u2500 sources\n \u2514\u2500\u2500 information_schema.csv\n```\n\n### Command Line\n\nUsing the CLI, you can have the S2V generator create the vault for you:\n\n```shell\nexport S2V_GENERATE_URL=https://the-s2v-server\ns2v generate -i MY_VAULT/ -o output/\n```\n\nThe results have been written to the `output/` directory.\n\nRun `s2v generate --help` to learn more about possible options.\n\n#### Setting up Shell Completion\n\nThe S2V CLI supports shell completion for Bash, Zsh and Fish.\n\nFor Bash, add this to your `~/.bashrc`:\n\n```shell\neval \"$(_S2V_COMPLETE=bash_source s2v)\"\n```\n\nFor Zsh, add this to your `~/.zshrc`:\n\n```shell\neval \"$(_S2V_COMPLETE=zsh_source s2v)\"\n```\n\nFor Fish, create a file named `~/.config/fish/completions/foo-bar.fish` with the following content:\n\n```shell\nenv _S2V_COMPLETE=fish_source s2v | source\n```\n\n### Library\n\nThe S2V client can also be embedded in your Python application.\n\nUsing the auth configuration file directly assumes your application to run in an Azure environment.\n\n```python\nimport pathlib\nfrom s2v.client import S2VClient\nfrom google.auth import external_account\n\ncredentials = external_account.Credentials.from_file(\"my_auth_config.json\")\ninput_dir = pathlib.Path(\"MY_VAULT\")\noutput_dir = pathlib.Path(\"output\")\nwith S2VClient.create(credentials) as s2v_client:\n s2v_client.generate(input_dir, output_dir)\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Stream2Vault Client",
"version": "0.9.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b261d02754038e541bf8d9d9f1d8ccc0f6b46308a22224b94bed5fcf1a76c35",
"md5": "41c1b964b21654cb9328ee4959b0d898",
"sha256": "bbe40a6fb02609610270ac14c092484aac135ba5d5852549d691206277804e0d"
},
"downloads": -1,
"filename": "s2v_client-0.9.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41c1b964b21654cb9328ee4959b0d898",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 41042,
"upload_time": "2024-12-05T12:13:06",
"upload_time_iso_8601": "2024-12-05T12:13:06.829801Z",
"url": "https://files.pythonhosted.org/packages/7b/26/1d02754038e541bf8d9d9f1d8ccc0f6b46308a22224b94bed5fcf1a76c35/s2v_client-0.9.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 12:13:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "s2v-client"
}
