keyvault-env 1.0.5

Upload secrets from a .env file to Azure Key Vault and fetch them easily.

keyvault-env

Prerequisites

• An Azure account and access to an Azure Key Vault .
• Azure CLI installed and logged in (az login).

---

🔑 Authentication

Before using the library, ensure you are authenticated with Azure:

az login

The library uses DefaultAzureCredential, which supports multiple authentication methods (CLI, Managed Identity, Service Principal, etc.).

---

🛠️ Usage

1. Initialize the Client

from keyvault_env.core import KeyVaultEnv

# Initialize with Key Vault URI
kv = KeyVaultEnv(kv_uri="https://your-vault-name.vault.azure.net")

# Or with just the vault name
kv = KeyVaultEnv(vault_name="your-vault-name")

2. Upload Secrets from .env

# Upload all secrets from .env
kv.set_secrets_from_env()

# Upload only secrets with a specific prefix
kv.set_secrets_from_env(prefix="SECRET_")

# Exclude specific keys
kv.set_secrets_from_env(exclude_keys=["DB_PASSWORD","API_KEY"])

3. Fetch Secrets

# Get a single secret
secret_value = kv.get_secret("my-secret-name")

# Get multiple secrets
secrets = kv.get_secrets(["secret1","secret2"])

# List all secret names
secret_names = kv.list_secret_names()

# Get all secrets (optionally filtered by prefix)
all_secrets = kv.get_all_secrets(prefix_filter="SECRET_")

---

📖 Function Reference

KeyVaultEnv(vault_name=None, kv_uri=None)

• Parameters :
• vault_name: Name of the Azure Key Vault (e.g., my-vault).
• kv_uri: Full URI of the Key Vault (e.g., https://my-vault.vault.azure.net).
• Raises : ValueError if neither vault_name nor kv_uri is provided.

set_secrets_from_env(env_path=".env", prefix="SECRET_", exclude_keys=None, normalize_names=True)

• Parameters :
• env_path: Path to the .env file.
• prefix: Only upload keys starting with this prefix.
• exclude_keys: List of keys to exclude from upload.
• normalize_names: If True, normalizes secret names for Key Vault compatibility.
• Returns : Dictionary of uploaded secrets.

set_secret(secret_name, value)

• Parameters :
• secret_name: Name of the secret.
• value: Value of the secret.
• Returns : None

get_secret(secret_name)

• Parameters :
• secret_name: Name of the secret to fetch.
• Returns : Value of the secret, or None if not found.

get_secrets(secret_names)

• Parameters :
• secret_names: List of secret names to fetch.
• Returns : Dictionary of secret names and values.

list_secret_names(prefix_filter=None)

• Parameters :
• prefix_filter: Only list secrets starting with this prefix.
• Returns : List of secret names.

get_all_secrets(prefix_filter=None)

• Parameters :
• prefix_filter: Only fetch secrets starting with this prefix.
• Returns : Dictionary of all secrets.

---

📝 Notes

• Environment Variables : The library respects KEYVAULT_URI and KEYVAULT_NAME environment variables for configuration.
• Normalization : Secret names are normalized to be Key Vault-compatible (lowercase, alphanumeric, hyphens).
• Error Handling : Errors are logged and skipped where possible.

---

💡 Example

<pre><div class="relative m-0 rounded-md border border-default bg-[#1e1e1e] whitespace-break-spaces dark:bg-subtle">``<div class="rounded-b-md select-text dark:bg-subtle!"><code class="language-python">``<span class="token">from <span> keyvault_env.core <span class="token">import <span> KeyVaultEnv

<span><span class="token"># Initialize <span> <span>kv <span class="token">=<span> KeyVaultEnv <span class="token">(<span>vault_name <span class="token">=<span class="token">"my-vault"<span class="token">)<span>

<span><span class="token"># Upload secrets <span> <span>kv <span class="token">.<span>set_secrets_from_env <span class="token">(<span>prefix <span class="token">=<span class="token">"SECRET_"<span class="token">)<span>

<span><span class="token"># Fetch secrets <span> <span>secrets <span class="token">=<span> kv <span class="token">.<span>get_all_secrets <span class="token">(<span>prefix_filter <span class="token">=<span class="token">"SECRET_"<span class="token">)<span> <span><span class="token">print <span class="token">(<span>secrets <span class="token">)</code></div>``</div></pre>

---

📄 License

MIT

---

You can **[download the README.md file here](sandbox/README.md)**.