| Name | tiny_vaultclient JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2023-09-21 19:59:41 |
| maintainer | |
| docs_url | None |
| author | Juan Borda |
| requires_python | >=3.11,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python Vault client
A simple client for read, list, write and delete secrets from Vault
## INSTALLATION
```bash
pip install tiny_vaultclient
```
or with poetry
```bash
poetry add tiny_vaultclient
```
## USAGE
look in [main.py](https://github.com/juanitomint/vaultclient/blob/main/main.py)
.env
this env vars are available with sabe defaults
| Variable | default value | Description |
|----------------|:--------------:| ------------:|
| VAULT_HOSTPORT |http://localhost:8200| url for vault endpoint|
| VAULT_PATH |"kubernetes-access"| path in Authentication Methods
|VAULT_ROLE |"my-api" | Role asociated to service account in kubernetes|
|VAULT_MOUNTPOINT| secret | Fixed muuntpoint for kv stores like /services or /apis|
|VAULT_SSL_VERIFY |True| Wheather or not verify the ssl certificate, useful for self signed certs|
## Uninstall/Remove
```bash
pip uninstall tiny_vaultclient
```
## TEST
spin up a local vault instance using docker
```bash
export VAULT_ADDR='http://127.0.0.1:8200'
make vault-up
vault login devtoken
make vault-secret
```
## HELP
```bash
cover/report Shows coverage Report
cover runs tests
cover/xml Creates coverage Report
deps config virtual env and install dependencies using poetry
docker-build Build docker image using latest as cache
docker-push Push docker image to remote ${IMAGE_REPOSITORY}
docker-test-bash test the docker image but gives yuou a shell
docker-test test file using docker image and .env variables
fix Fix code lints using black flake8 and isort
lint Show code lints using black flake8 and isort
local installs pre-commit hook (WIP)
printvars Prints make variables
vault-down Removes docker vault container
vault-secret Create a new version of secrets
vault-up Spin up a vault development server use it with export VAULT_ADDR='http://127.0.0.1:8200'
```
Raw data
{
"_id": null,
"home_page": "",
"name": "tiny_vaultclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Juan Borda",
"author_email": "juanignacioborda@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/14/6c/02d8042cf4d34c102b8db21bb15dc2de12e3ba89d7b47b3ed7aa1d597441/tiny_vaultclient-0.1.2.tar.gz",
"platform": null,
"description": "# Python Vault client\n\nA simple client for read, list, write and delete secrets from Vault\n\n## INSTALLATION\n\n```bash\npip install tiny_vaultclient\n```\n\nor with poetry\n```bash\npoetry add tiny_vaultclient\n```\n## USAGE\nlook in [main.py](https://github.com/juanitomint/vaultclient/blob/main/main.py)\n\n.env \nthis env vars are available with sabe defaults\n| Variable | default value | Description |\n|----------------|:--------------:| ------------:|\n| VAULT_HOSTPORT |http://localhost:8200| url for vault endpoint| \n| VAULT_PATH |\"kubernetes-access\"| path in Authentication Methods\n|VAULT_ROLE |\"my-api\" | Role asociated to service account in kubernetes|\n|VAULT_MOUNTPOINT| secret | Fixed muuntpoint for kv stores like /services or /apis|\n|VAULT_SSL_VERIFY |True| Wheather or not verify the ssl certificate, useful for self signed certs|\n\n## Uninstall/Remove\n\n```bash\npip uninstall tiny_vaultclient\n```\n\n## TEST\n\n\nspin up a local vault instance using docker\n```bash\nexport VAULT_ADDR='http://127.0.0.1:8200' \n\nmake vault-up \nvault login devtoken\nmake vault-secret \n```\n\n\n## HELP\n```bash\ncover/report Shows coverage Report\ncover runs tests\ncover/xml Creates coverage Report\ndeps config virtual env and install dependencies using poetry\ndocker-build Build docker image using latest as cache\ndocker-push Push docker image to remote ${IMAGE_REPOSITORY}\ndocker-test-bash test the docker image but gives yuou a shell\ndocker-test test file using docker image and .env variables\nfix Fix code lints using black flake8 and isort\nlint Show code lints using black flake8 and isort\nlocal installs pre-commit hook (WIP)\nprintvars Prints make variables\nvault-down Removes docker vault container\nvault-secret Create a new version of secrets\nvault-up Spin up a vault development server use it with export VAULT_ADDR='http://127.0.0.1:8200'\n```",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c3fcc3c27cbf3732810c0af04b2df0567c7be253ae9ed6be41eee4b5638da77",
"md5": "382b3d6f907c1148792d63ee3eb49a23",
"sha256": "4b6b33bce9148cdfa6531fe3d3b538607d75b79da1043be2e4a2905eeb9031da"
},
"downloads": -1,
"filename": "tiny_vaultclient-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "382b3d6f907c1148792d63ee3eb49a23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 4236,
"upload_time": "2023-09-21T19:59:40",
"upload_time_iso_8601": "2023-09-21T19:59:40.679169Z",
"url": "https://files.pythonhosted.org/packages/4c/3f/cc3c27cbf3732810c0af04b2df0567c7be253ae9ed6be41eee4b5638da77/tiny_vaultclient-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "146c02d8042cf4d34c102b8db21bb15dc2de12e3ba89d7b47b3ed7aa1d597441",
"md5": "21d7b33b3bfa1719eefac2de0fa4c009",
"sha256": "fb05b6756aa1dbf69d0660fcba1648780849022b8f4ec0d2a22cd25db06167d3"
},
"downloads": -1,
"filename": "tiny_vaultclient-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "21d7b33b3bfa1719eefac2de0fa4c009",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 3773,
"upload_time": "2023-09-21T19:59:41",
"upload_time_iso_8601": "2023-09-21T19:59:41.740697Z",
"url": "https://files.pythonhosted.org/packages/14/6c/02d8042cf4d34c102b8db21bb15dc2de12e3ba89d7b47b3ed7aa1d597441/tiny_vaultclient-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-21 19:59:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tiny_vaultclient"
}
