# prefect-vault
## Welcome!
Prefect blocks for HashiCorp Vault.
## Getting Started
### Python setup
Requires an installation of Python 3.7+.
We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the [Prefect documentation](https://orion-docs.prefect.io/).
### Installation
Install `prefect-vault` with `pip`:
```bash
pip install prefect-vault
```
### Create VaultSecret block with token authentication
```python
from prefect_vault import VaultSecret, VaultToken
vault_secret = VaultSecret(
vault_auth=VaultToken(
vault_url='http://myvault:8200',
token='my_secret_token',
),
)
await vault_secret.save('my-vault-secret')
```
### Create VaultSecret block with approle authentication
```python
from prefect_vault import VaultAppRole, VaultSecret
vault_secret = VaultSecret(
vault_auth=VaultAppRole(
vault_url='http://myvault:8200',
role_id='my_role_id',
secret_id='my_secret_id',
),
)
await vault_secret.save('my-vault-secret')
```
### Use VaultSecret in Prefect flow
```python
from prefect import flow
from prefect_vault import VaultSecret
@flow
async def use_vault_secret():
vault_secret = await VaultSecret.load('my-vault-secret')
secret_value = vault_secret.get_secret('path/to/my/secret')['secret_key']
```
## Resources
If you encounter any bugs while using `prefect-vault`, feel free to open an issue in the [prefect-vault](https://github.com/pbchekin/prefect-vault) repository.
If you have any questions or issues while using `prefect-vault`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).
## Development
If you'd like to install a version of `prefect-vault` for development, clone the repository and perform an editable install with `pip`:
```bash
git clone https://github.com/pbchekin/prefect-vault.git
cd prefect-vault/
pip install -e ".[dev]"
# Install linting pre-commit hooks
pre-commit install
```
Raw data
{
"_id": null,
"home_page": "https://github.com/pbchekin/prefect-vault",
"name": "prefect-vault",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "prefect",
"author": "Pavel Chekin",
"author_email": "pbchekin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e1/f3/f70e43357a5f099586aa1dde3dbd2b54902490ed8c9abc7f34abc0e38680/prefect-vault-0.1.5.tar.gz",
"platform": null,
"description": "# prefect-vault\n\n## Welcome!\n\nPrefect blocks for HashiCorp Vault.\n\n## Getting Started\n\n### Python setup\n\nRequires an installation of Python 3.7+.\n\nWe recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.\n\nThese tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the [Prefect documentation](https://orion-docs.prefect.io/).\n\n### Installation\n\nInstall `prefect-vault` with `pip`:\n\n```bash\npip install prefect-vault\n```\n\n### Create VaultSecret block with token authentication\n\n```python\nfrom prefect_vault import VaultSecret, VaultToken\n\nvault_secret = VaultSecret(\n vault_auth=VaultToken(\n vault_url='http://myvault:8200',\n token='my_secret_token',\n ),\n)\n\nawait vault_secret.save('my-vault-secret')\n```\n\n### Create VaultSecret block with approle authentication\n\n```python\nfrom prefect_vault import VaultAppRole, VaultSecret \n\nvault_secret = VaultSecret(\n vault_auth=VaultAppRole(\n vault_url='http://myvault:8200',\n role_id='my_role_id',\n secret_id='my_secret_id',\n ),\n)\n\nawait vault_secret.save('my-vault-secret')\n```\n\n### Use VaultSecret in Prefect flow\n\n```python\nfrom prefect import flow\nfrom prefect_vault import VaultSecret\n\n\n@flow\nasync def use_vault_secret():\n vault_secret = await VaultSecret.load('my-vault-secret')\n secret_value = vault_secret.get_secret('path/to/my/secret')['secret_key']\n```\n\n## Resources\n\nIf you encounter any bugs while using `prefect-vault`, feel free to open an issue in the [prefect-vault](https://github.com/pbchekin/prefect-vault) repository.\n\nIf you have any questions or issues while using `prefect-vault`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).\n\n## Development\n\nIf you'd like to install a version of `prefect-vault` for development, clone the repository and perform an editable install with `pip`:\n\n```bash\ngit clone https://github.com/pbchekin/prefect-vault.git\n\ncd prefect-vault/\n\npip install -e \".[dev]\"\n\n# Install linting pre-commit hooks\npre-commit install\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Prefect HashiCorp Vault blocks.",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/pbchekin/prefect-vault"
},
"split_keywords": [
"prefect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf09ce6d049ae75337fdff8fdca6bb931ac62429ee887973cceec10f43c9ad78",
"md5": "e8f10e48af2aee7faceea054e8ea9984",
"sha256": "f69d69e6799e2b94bd3163af738163f6e1396213c8aad6b87093a6f35b46b83a"
},
"downloads": -1,
"filename": "prefect_vault-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8f10e48af2aee7faceea054e8ea9984",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8663,
"upload_time": "2023-12-06T19:42:18",
"upload_time_iso_8601": "2023-12-06T19:42:18.327620Z",
"url": "https://files.pythonhosted.org/packages/bf/09/ce6d049ae75337fdff8fdca6bb931ac62429ee887973cceec10f43c9ad78/prefect_vault-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1f3f70e43357a5f099586aa1dde3dbd2b54902490ed8c9abc7f34abc0e38680",
"md5": "782c18ca59649d6993c8ce7a8e2e1006",
"sha256": "ae2f5065cb4889fc5b291902c99e6ab144e51e89bab5e2045129ebaec53744a8"
},
"downloads": -1,
"filename": "prefect-vault-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "782c18ca59649d6993c8ce7a8e2e1006",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 25586,
"upload_time": "2023-12-06T19:42:25",
"upload_time_iso_8601": "2023-12-06T19:42:25.505446Z",
"url": "https://files.pythonhosted.org/packages/e1/f3/f70e43357a5f099586aa1dde3dbd2b54902490ed8c9abc7f34abc0e38680/prefect-vault-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 19:42:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pbchekin",
"github_project": "prefect-vault",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "prefect-vault"
}
JSON
