essentials-configuration-keyvault
Azure Key
Vault
source for
essentials-configuration.
pip install essentials-configuration-keyvault
essentials-configuration provides a way to handle configuration roots
composed of different layers, such as configuration files and environmental
variables. Layers are applied in order and can override each others' values,
enabling different scenarios like configuration by environment (e.g. DEV, TEST,
PROD) and system instance.
essentials-configuration-keyvault provides a solution to add secrets stored
in Azure Key Vault into configuration objects.
Example:
from azure.identity import DefaultAzureCredential
from azure.keyvault.secrets import SecretClient
from config.common import ConfigurationBuilder
from config.keyvault import KeyVaultSource
key_vault_name = "example-keyvault-name"
secrets_client = SecretClient(
vault_url=f"https://{key_vault_name}.vault.azure.net",
credential=DefaultAzureCredential(),
)
builder = ConfigurationBuilder(KeyVaultSource(secrets_client))
# when the configuration object is built, secrets are fetched from
# the linked key vault and put into the configuration object (e.g.
# database connection strings, API keys for SendGrid, etc.)
config = builder.build()
Refer to the official Key Vault documentation for more information about its Python client library..
How to run the tests using a real Key Vault
The provided tests can either use a mocked SecretClient, or use a real Key Vault.
To use a real Key Vault service:
- create a Key Vault (ref.)
- sign-in using any way supported by
azure.identity.DefaultAzureCredential3 (e.g. VS Code oraz login) - run the tests with the following command:
KEYVAULT_NAME="<YOUR_KEYVAULT_NAME>" pytest -s
Metadata
Release files for essentials-configuration-keyvault 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| essentials_configuration_keyvault-1.0.1.tar.gz | 3.7 kB | Without provenance | Details for essentials_configuration_keyvault-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| essentials_configuration_keyvault-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for essentials_configuration_keyvault-1.0.1-py3-none-any.whl |
Total release size: 7.6 kB
Release files / essentials_configuration_keyvault-1.0.1.tar.gz
| Download URL | essentials_configuration_keyvault-1.0.1.tar.gz |
|---|---|
| Size | 3.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e7d06539ab5d070afca21cd42a7b13ea525a899f1ca189cf516d6826b5f504c9
|
|
BLAKE2b-256 checksum How to use checksums |
13a1c2d8f12a3013453f1c9c8be9de52cd0656858f6f119b72f0dc74ba504cc0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Release files / essentials_configuration_keyvault-1.0.1-py3-none-any.whl
| Download URL | essentials_configuration_keyvault-1.0.1-py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6e355b324d80a20d46cd165b4e31a1f14513e529217cd8d2516459bef736a1c9
|
|
BLAKE2b-256 checksum How to use checksums |
3c91bfdc5a952ab7731afa0876f7932ed0588a13f4c19680fe292d8a02f069c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Security for essentials-configuration-keyvault 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.