| Name | VaultAPI-Client JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Client application for VaultAPI Server |
| upload_time | 2025-01-14 03:12:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2025 TheVickypedia Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
vaultapi
vault
fastapi
sqlite3
fernet
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
cryptography
python-dotenv
requests
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# VaultAPI-Client-python
Client application for VaultAPI Server
![Python][label-pyversion]
**Platform Supported**
![Platform][label-platform]
**Deployments**
[![pypi][label-actions-pypi]][gha_pypi]
[![markdown][label-actions-markdown]][gha_md_valid]
[![Pypi][label-pypi]][pypi]
[![Pypi-format][label-pypi-format]][pypi-files]
[![Pypi-status][label-pypi-status]][pypi]
## Kick off
**Recommendations**
- Install `python` [3.10] or [3.11]
- Use a dedicated [virtual environment]
**Install VaultAPI**
```shell
python -m pip install vaultapi
```
**Initiate - IDE**
```python
import vaultapi
if __name__ == '__main__':
vaultapi.decrypt(get_secret="mykey", table="mytable")
```
**Initiate - CLI**
```shell
vaultapi --table mytable
```
> Use `vaultapi --help` for usage instructions.
## Environment Variables
<details>
<summary><strong>Sourcing environment variables from an env file</strong></summary>
> _By default, `VaultAPI-Client` will look for a `.env` file in the current working directory._
</details>
**Mandatory**
- **APIKEY** - API Key for authentication.
- **VAULT_SERVER** - VaultAPI server URL.
## Coding Standards
Docstring format: [`Google`][google-docs] <br>
Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
## Linting
`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
markdown files (including Wiki pages)
**Requirement**
```shell
python -m pip install pre-commit
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[![pypi-module][label-pypi-package]][pypi-repo]
[https://pypi.org/project/VaultAPI-Client/][pypi]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[label-actions-markdown]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/markdown.yml/badge.svg
[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-VaultAPI_Client-blue?style=for-the-badge&logo=Python
[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
[label-actions-pypi]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/python-publish.yml/badge.svg
[label-pypi]: https://img.shields.io/pypi/v/VaultAPI-Client
[label-pypi-format]: https://img.shields.io/pypi/format/VaultAPI-Client
[label-pypi-status]: https://img.shields.io/pypi/status/VaultAPI-Client
[3.10]: https://docs.python.org/3/whatsnew/3.10.html
[3.11]: https://docs.python.org/3/whatsnew/3.11.html
[virtual environment]: https://docs.python.org/3/tutorial/venv.html
[release-notes]: https://github.com/thevickypedia/VaultAPI-Client-python/blob/main/release_notes.rst
[gha_pages]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/pages/pages-build-deployment
[gha_pypi]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/python-publish.yml
[gha_md_valid]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/markdown.yml
[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
[pep8]: https://www.python.org/dev/peps/pep-0008/
[isort]: https://pycqa.github.io/isort/
[pypi]: https://pypi.org/project/VaultAPI-Client
[pypi-files]: https://pypi.org/project/VaultAPI-Client/#files
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
[license]: https://github.com/thevickypedia/VaultAPI-Client-python/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": null,
"name": "VaultAPI-Client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "vaultapi, vault, fastapi, sqlite3, fernet",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"platform": null,
"description": "# VaultAPI-Client-python\nClient application for VaultAPI Server\n\n![Python][label-pyversion]\n\n**Platform Supported**\n\n![Platform][label-platform]\n\n**Deployments**\n\n[![pypi][label-actions-pypi]][gha_pypi]\n[![markdown][label-actions-markdown]][gha_md_valid]\n\n[![Pypi][label-pypi]][pypi]\n[![Pypi-format][label-pypi-format]][pypi-files]\n[![Pypi-status][label-pypi-status]][pypi]\n\n## Kick off\n\n**Recommendations**\n\n- Install `python` [3.10] or [3.11]\n- Use a dedicated [virtual environment]\n\n**Install VaultAPI**\n```shell\npython -m pip install vaultapi\n```\n\n**Initiate - IDE**\n```python\nimport vaultapi\n\n\nif __name__ == '__main__':\n vaultapi.decrypt(get_secret=\"mykey\", table=\"mytable\")\n```\n\n**Initiate - CLI**\n```shell\nvaultapi --table mytable\n```\n\n> Use `vaultapi --help` for usage instructions.\n\n## Environment Variables\n\n<details>\n<summary><strong>Sourcing environment variables from an env file</strong></summary>\n\n> _By default, `VaultAPI-Client` will look for a `.env` file in the current working directory._\n</details>\n\n**Mandatory**\n- **APIKEY** - API Key for authentication.\n- **VAULT_SERVER** - VaultAPI server URL.\n\n## Coding Standards\nDocstring format: [`Google`][google-docs] <br>\nStyling conventions: [`PEP 8`][pep8] and [`isort`][isort]\n\n## Linting\n`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL\nmarkdown files (including Wiki pages)\n\n**Requirement**\n```shell\npython -m pip install pre-commit\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[![pypi-module][label-pypi-package]][pypi-repo]\n\n[https://pypi.org/project/VaultAPI-Client/][pypi]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[label-actions-markdown]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/markdown.yml/badge.svg\n[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-VaultAPI_Client-blue?style=for-the-badge&logo=Python\n[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue\n[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg\n[label-actions-pypi]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/python-publish.yml/badge.svg\n[label-pypi]: https://img.shields.io/pypi/v/VaultAPI-Client\n[label-pypi-format]: https://img.shields.io/pypi/format/VaultAPI-Client\n[label-pypi-status]: https://img.shields.io/pypi/status/VaultAPI-Client\n\n[3.10]: https://docs.python.org/3/whatsnew/3.10.html\n[3.11]: https://docs.python.org/3/whatsnew/3.11.html\n[virtual environment]: https://docs.python.org/3/tutorial/venv.html\n[release-notes]: https://github.com/thevickypedia/VaultAPI-Client-python/blob/main/release_notes.rst\n[gha_pages]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/pages/pages-build-deployment\n[gha_pypi]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/python-publish.yml\n[gha_md_valid]: https://github.com/thevickypedia/VaultAPI-Client-python/actions/workflows/markdown.yml\n[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings\n[pep8]: https://www.python.org/dev/peps/pep-0008/\n[isort]: https://pycqa.github.io/isort/\n[pypi]: https://pypi.org/project/VaultAPI-Client\n[pypi-files]: https://pypi.org/project/VaultAPI-Client/#files\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\n[license]: https://github.com/thevickypedia/VaultAPI-Client-python/blob/main/LICENSE\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 TheVickypedia Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Client application for VaultAPI Server",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/thevickypedia/VaultAPI-Client-python",
"Source": "https://github.com/thevickypedia/VaultAPI-Client-python"
},
"split_keywords": [
"vaultapi",
" vault",
" fastapi",
" sqlite3",
" fernet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87cb2a6321ce803be46b801aab734ca1624c211dd5374d2f7e5df47d8493b536",
"md5": "17f49a6f77c9a30dd55f1ee9df3c8e21",
"sha256": "24f36c8707542fef8ef1b94c143104f0af9d45056e8e4e8b1fb5add6d6ba9c24"
},
"downloads": -1,
"filename": "VaultAPI_Client-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17f49a6f77c9a30dd55f1ee9df3c8e21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6573,
"upload_time": "2025-01-14T03:12:25",
"upload_time_iso_8601": "2025-01-14T03:12:25.511541Z",
"url": "https://files.pythonhosted.org/packages/87/cb/2a6321ce803be46b801aab734ca1624c211dd5374d2f7e5df47d8493b536/VaultAPI_Client-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 03:12:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "VaultAPI-Client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cryptography",
"specs": [
[
"==",
"44.0.*"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.*"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.*"
]
]
}
],
"lcname": "vaultapi-client"
}
