Metadata-Version: 2.1
Name: robocorp-vault
Version: 1.3.1
Summary: Robocorp Control Room Vault API integration library
Home-page: https://github.com/robocorp/robocorp/
License: Apache-2.0
Author: Fabio Z.
Author-email: fabio@robocorp.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: cryptography (>=41.0.1,<42.0.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: requests (>=2.31,<3.0)
Requires-Dist: tenacity (>=8.0.1,<9.0.0)
Project-URL: Repository, https://github.com/robocorp/robocorp/
Description-Content-Type: text/markdown

# robocorp-vault

`robocorp-vault` is a library that provides read and write access to the
[Vault](https://robocorp.com/docs/development-guide/variables-and-secrets/vault)
in Robocorp Control Room, which can be used to store and retrieve secret values such as passwords.

## Getting started

A secret consists of a name, an optional description, and a map of
keys and values. For instance, one secret can be login credentials for a website,
which includes both a username and a password:

```python
from robocorp.tasks import task
from robocorp import vault

@task
def inspect_secret():
    secret = vault.get_secret("login_credentials")
    print("Secret name:", secret.name)
    print("Secret description:", secret.description)
    print("Secret keys:", secret.keys())
    print("Secret value:", secret["username"])
```

## Guides

- [Local development](https://github.com/robocorp/robocorp/blob/master/vault/docs/guides/00-local-development.md)
- [Hiding values](https://github.com/robocorp/robocorp/blob/master/vault/docs/guides/01-hiding-values.md)
- [Modifying secrets](https://github.com/robocorp/robocorp/blob/master/vault/docs/guides/02-modifying-secrets.md)

Further user guides and tutorials can be found in [Robocorp Docs](https://robocorp.com/docs).

## API Reference

Information on specific functions or classes: [robocorp.vault](https://github.com/robocorp/robocorp/blob/master/vault/docs/api/robocorp.vault.md)

## Changelog

A list of releases and corresponding changes can be found in the [changelog](https://github.com/robocorp/robocorp/blob/master/vault/docs/CHANGELOG.md).

