tinyvaultclient


Nametinyvaultclient JSON
Version 0.1.6 PyPI version JSON
download
home_page
Summary
upload_time2023-09-22 17:51:10
maintainer
docs_urlNone
authorJuan 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": "tinyvaultclient",
    "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/af/ed/1dedc5ac4a2fb96df8a2de0cfe3ce478bef69edc3ce0f8d07b8e7a5ee5d8/tinyvaultclient-0.1.6.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.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fe0f9796fa0984ae75482b14960012ba4c1df01d13e4cb93f3814a7951255f76",
                "md5": "126e81f0409502fe4c473e4332aaa27e",
                "sha256": "7371b7510aa97ef1fdff70d411b039113857e58ca6302dcbfb36b7edbb457de5"
            },
            "downloads": -1,
            "filename": "tinyvaultclient-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "126e81f0409502fe4c473e4332aaa27e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0",
            "size": 4259,
            "upload_time": "2023-09-22T17:51:09",
            "upload_time_iso_8601": "2023-09-22T17:51:09.036356Z",
            "url": "https://files.pythonhosted.org/packages/fe/0f/9796fa0984ae75482b14960012ba4c1df01d13e4cb93f3814a7951255f76/tinyvaultclient-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "afed1dedc5ac4a2fb96df8a2de0cfe3ce478bef69edc3ce0f8d07b8e7a5ee5d8",
                "md5": "5c332ac86b25b35937cb958dd1654636",
                "sha256": "f4fe0e4329f39e17a4e9d582ba4736daba8694b91e35aa050a978906e44bd362"
            },
            "downloads": -1,
            "filename": "tinyvaultclient-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "5c332ac86b25b35937cb958dd1654636",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 3800,
            "upload_time": "2023-09-22T17:51:10",
            "upload_time_iso_8601": "2023-09-22T17:51:10.333452Z",
            "url": "https://files.pythonhosted.org/packages/af/ed/1dedc5ac4a2fb96df8a2de0cfe3ce478bef69edc3ce0f8d07b8e7a5ee5d8/tinyvaultclient-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-22 17:51:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "tinyvaultclient"
}
        
Elapsed time: 0.29043s