env-use 1.0.0__py3-none-any.whl

env_use-1.0.0.dist-info/METADATA

@@ -0,0 +1,401 @@
+Metadata-Version: 2.4
+Name: env-use
+Version: 1.0.0
+Summary: Environment file processor with extensible secret providers
+Author-email: Developer <dev@example.com>
+License: MIT
+Keywords: cli,configuration,devops,environment,secrets
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Provides-Extra: 1password
+Requires-Dist: aiohttp>=3.9.0; extra == '1password'
+Provides-Extra: all
+Requires-Dist: aiohttp>=3.9.0; extra == 'all'
+Requires-Dist: azure-identity>=1.15.0; extra == 'all'
+Requires-Dist: azure-keyvault-secrets>=4.8.0; extra == 'all'
+Requires-Dist: boto3>=1.34.0; extra == 'all'
+Requires-Dist: google-cloud-secret-manager>=2.20.0; extra == 'all'
+Requires-Dist: hvac>=2.1.0; extra == 'all'
+Provides-Extra: aws
+Requires-Dist: boto3>=1.34.0; extra == 'aws'
+Provides-Extra: azure
+Requires-Dist: azure-identity>=1.15.0; extra == 'azure'
+Requires-Dist: azure-keyvault-secrets>=4.8.0; extra == 'azure'
+Provides-Extra: dev
+Requires-Dist: coverage[toml]>=7.0; extra == 'dev'
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.12; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: python-semantic-release>=9.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: gcp
+Requires-Dist: google-cloud-secret-manager>=2.20.0; extra == 'gcp'
+Provides-Extra: vault
+Requires-Dist: hvac>=2.1.0; extra == 'vault'
+Description-Content-Type: text/markdown
+
+# use-env
+
+[![Release](https://github.com/SamCullin/use-env/actions/workflows/release.yml/badge.svg)](https://github.com/SamCullin/use-env/actions/workflows/release.yml)
+[![CI](https://github.com/SamCullin/use-env/actions/workflows/ci.yml/badge.svg)](https://github.com/SamCullin/use-env/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/env-use.svg)](https://badge.fury.io/py/env-use)
+[![GitHub Release](https://img.shields.io/github/v/release/SamCullin/use-env)](https://github.com/SamCullin/use-env/releases)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/SamCullin/use-env/graphs/commit-activity)
+[![Downloads](https://img.shields.io/pypi/dm/env-use.svg)](https://pypi.org/project/env-use/)
+[![GitHub issues](https://img.shields.io/github/issues/SamCullin/use-env.svg)](https://github.com/SamCullin/use-env/issues)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://makeapullrequest.com)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+
+[use-env](/) > [use_env](/use_env/) > [providers](/use_env/providers/) > [tests](/tests/) > [.github](/.github/) > [docs](/docs/) > [examples](/examples/)
+
+[!['Buy Me A Coffee'](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/samcullin)
+
+## Summary
+**Environment file processor with extensible secret providers.**
+
+
+`use-env` is a CLI tool for developers that processes environment files with secret references and resolves them from various providers (vault, environment variables, files, etc.).
+
+## Features
+
+- **Extensible Provider System**: Add custom providers for any secret source
+- **Built-in Providers**: Support for environment variables and files (no external dependencies)
+- **Optional Cloud Providers**: Azure, AWS, GCP, HashiCorp Vault, 1Password (install only what you need)
+- **Configuration**: YAML-based configuration for custom providers
+- **Type Safety**: Written in Python with full type annotations
+- **Test Coverage**: Comprehensive test suite
+
+## Installation
+
+```bash
+# Core package only (env and file providers)
+pip install env-use
+
+# Or using uv
+uv pip install env-use
+```
+
+### Optional Cloud Providers
+
+Install only the providers you need:
+
+```bash
+# Azure Key Vault (Python SDK)
+pip install env-use[azure]
+
+# AWS Secrets Manager
+pip install env-use[aws]
+
+# Google Cloud Secret Manager
+pip install env-use[gcp]
+
+# HashiCorp Vault
+pip install env-use[vault]
+
+# 1Password Connect
+pip install env-use[1password]
+
+# All cloud providers
+pip install env-use[all]
+```
+
+## Quick Start
+
+### Basic Usage
+
+```bash
+# Process .env.dev and output .env
+use-env .env.dev
+
+# Specify output file
+use-env .env.prod -o .env.production
+
+# List available providers
+use-env --list-providers
+```
+
+### Environment File Example
+
+Create a `.env.dev` file:
+
+```bash
+# Regular values
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+
+# Environment variable reference
+API_KEY=${env:MY_API_KEY}
+
+# File-based secret (Docker secrets, etc.)
+DB_PASSWORD=${file:/run/secrets/db_password}
+
+# Azure Key Vault (requires env-use[azure])
+# Format: ${azure-keyvault:<vault_name>/<secret_name>}
+SECRET_KEY=${azure-keyvault:my-keyvault/db-password}
+
+# AWS Secrets Manager (requires env-use[aws])
+# Format: ${aws-secrets:<region>/<secret_name>}
+DB_PASSWORD=${aws-secrets:us-east-1/my-app/database}
+
+# GCP Secret Manager (requires env-use[gcp])
+# Format: ${gcp-secrets:<project_id>/<secret_name>}
+API_KEY=${gcp-secrets:my-project/api-key}
+
+# HashiCorp Vault (requires env-use[vault])
+# Format: ${vault:<mount_point>/<path>}
+DB_PASSWORD=${vault:secret/my-app/database}
+
+# 1Password (requires env-use[1password])
+# Format: ${1password:<vault_id>/<item_id>/<field>}
+API_KEY=${1password:vault-id/item-id/api-key}
+```
+
+Run the tool:
+
+```bash
+use-env .env.dev
+```
+
+This will create a `.env` file with all references resolved.
+
+### Piping Support
+
+The tool supports piping for flexible workflows:
+
+```bash
+# Pipe input from stdin, output to stdout
+cat .env.dev | use-env
+
+# Pipe input, save output to file
+cat .env.dev | use-env > .env
+
+# Pipe output to another command
+use-env .env.prod | grep DB_HOST
+
+# Chain with other tools
+cat .env.staging | use-env | jq '.DATABASE_'
+```
+
+When input comes from stdin, output automatically goes to stdout. This enables standard Unix workflows.
+
+## Core Providers (No Extra Dependencies)
+
+### Environment Provider (`env`)
+
+Reference environment variables:
+
+```bash
+API_KEY=${env:API_KEY}
+```
+
+### File Provider (`file`)
+
+Read secrets from files:
+
+```bash
+# Absolute path
+DB_PASSWORD=${file:/run/secrets/db_password}
+
+# Relative path (relative to config or current directory)
+API_KEY=${file:./secrets/api_key.txt}
+```
+
+## Optional Cloud Providers
+
+### Azure Key Vault (`azure-keyvault`)
+
+Requires: `pip install env-use[azure]`
+
+```bash
+# Format: ${azure-keyvault:<vault_name>/<secret_name>}
+DB_PASSWORD=${azure-keyvault:my-keyvault/db-password}
+```
+
+Configuration (in `.use-env.yaml`):
+
+```yaml
+providers:
+  - name: azure
+    type: azure-keyvault
+    enabled: true
+    config:
+      tenant_id: "your-tenant-id"  # Optional, uses default credential
+      client_id: "your-client-id"  # Optional
+      client_secret: "your-secret" # Optional
+```
+
+### AWS Secrets Manager (`aws-secrets`)
+
+Requires: `pip install env-use[aws]`
+
+```bash
+# Format: ${aws-secrets:<region>/<secret_name>}
+DB_PASSWORD=${aws-secrets:us-east-1/my-app/database}
+```
+
+Configuration:
+
+```yaml
+providers:
+  - name: aws
+    type: aws-secrets
+    enabled: true
+    config:
+      region: "us-east-1"           # Optional, uses default session
+      profile: "my-aws-profile"     # Optional
+```
+
+### GCP Secret Manager (`gcp-secrets`)
+
+Requires: `pip install env-use[gcp]`
+
+```bash
+# Format: ${gcp-secrets:<project_id>/<secret_name>}
+API_KEY=${gcp-secrets:my-project/api-key}
+```
+
+Configuration:
+
+```yaml
+providers:
+  - name: gcp
+    type: gcp-secrets
+    enabled: true
+    config:
+      project_id: "my-gcp-project"  # Optional, uses default
+```
+
+### HashiCorp Vault (`vault`)
+
+Requires: `pip install env-use[vault]`
+
+```bash
+# Format: ${vault:<mount_point>/<path>}
+DB_PASSWORD=${vault:secret/my-app/database}
+DB_HOST=${vault:secret/my-app/host}  # Returns specific field if secret is JSON
+```
+
+Configuration:
+
+```yaml
+providers:
+  - name: vault
+    type: vault
+    enabled: true
+    config:
+      url: "http://127.0.0.1:8200"  # Optional, uses VAULT_ADDR env var
+      token: "your-vault-token"     # Optional, uses VAULT_TOKEN env var
+      namespace: "your-namespace"   # Optional, for Enterprise Vault
+      mount_point: "secret"         # Optional, default mount point
+```
+
+### 1Password Connect (`1password`)
+
+Requires: `pip install env-use[1password]`
+
+```bash
+# Format: ${1password:<vault_id>/<item_id>/<field>}
+API_KEY=${1password:vault-uuid/item-uuid/api-key}
+```
+
+Configuration:
+
+```yaml
+providers:
+  - name: onepassword
+    type: 1password
+    enabled: true
+    config:
+      connect_url: "http://localhost:8080"  # Optional, uses OP_CONNECT_HOST
+      connect_token: "your-token"           # Optional, uses OP_CONNECT_TOKEN
+```
+
+## Configuration
+
+Create a `.use-env.yaml` file to configure providers:
+
+```yaml
+providers:
+  - name: azure
+    type: azure-keyvault
+    enabled: true
+    config:
+      tenant_id: "your-tenant-id"
+
+  - name: aws
+    type: aws-secrets
+    enabled: true
+    config:
+      region: "us-east-1"
+
+options:
+  strict: true
+  verbose: 1
+```
+
+## Adding Custom Providers
+
+See [Provider Development Guide](docs/provider_development.md) for detailed instructions.
+
+## Documentation
+
+- [Architecture](docs/architecture.md) - Internal design and components
+- [Provider Development](docs/provider_development.md) - Guide for creating custom providers
+- [Usage Guide](docs/usage.md) - Detailed usage instructions
+
+## Testing
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=use_env
+
+# Run specific test file
+pytest tests/test_providers.py
+```
+
+## CI/CD
+
+This project uses GitHub Actions for continuous integration and deployment:
+
+### Pull Requests
+- Runs on Python 3.12 and 3.13
+- Ruff linting and formatting checks
+- MyPy type checking
+- Pytest with coverage
+- Coverage uploaded to Codecov
+
+### Releases
+- Automatically versions using [python-semantic-release](https://python-semantic-release.readthedocs.io/)
+- Maintains a release PR branch from `main`/`master`
+- Pushes a new version tag when a release PR is merged
+- Publishes to PyPI and creates a GitHub Release on version tags
+
+### Commit Convention
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat: add new provider
+fix: resolve caching issue
+docs: update documentation
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
+
+## License
+
+MIT License - see LICENSE file for details.

env_use-1.0.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+use_env/__init__.py,sha256=LKBkbMvFb-4AZhPNL0nIpBSXsPqK4AqeEudxmbtDnoU,652
+use_env/cli.py,sha256=Nre42EmYawP36l30MaE5XLSMzEVkAjoj2cFIbdTV83E,7608
+use_env/config.py,sha256=WXhR3fqH_hxi2sP8uAzg8JMKJFVOiLggQUJmwad9Neo,3431
+use_env/loader.py,sha256=v2NyT6tgpL6hWSDraKUKO8T0v0swbJ3RsWswUnVSLwU,9231
+use_env/providers/__init__.py,sha256=kxlGNqRXIA-32EXdUweKx-r_RqQqOqt7_fQCe1uTm5Q,9431
+use_env/providers/aws.py,sha256=BkwEVQEEYvfnsX8S6scJ_-nJjy42kCeE-CoH5pLQRHw,6535
+use_env/providers/azure.py,sha256=MjXArZVLHI5I_hAJFbETX9YYLpKjRyH-pCQX68g-EYQ,4820
+use_env/providers/built_in.py,sha256=BHYEowIXON1NHuGbo3qds-RVi_J0kMSw7HRS74IWgNg,1025
+use_env/providers/env.py,sha256=ggw65BZm1RmPDCFXTOImWNRXTQ-X5_cVZPsIkjrlP4A,4613
+use_env/providers/file.py,sha256=ozGsORr-aJ3qTlyBIThQKWdCku35Px9eSPF-kxUUxOk,4156
+use_env/providers/gcp.py,sha256=XZclWDrdk7aF2rZ3CRZghhTnH6GchImJwOF4ToTB6I8,4378
+use_env/providers/hashicorp.py,sha256=tjU0pBNHz-tu0sy_kFdddgreHIPetmpbs_mMFtTytag,6906
+use_env/providers/onepassword.py,sha256=DtbsOkcRgejD7kRHQaJIcnWyTf1yh2eDWw-3droZa6Q,6630
+env_use-1.0.0.dist-info/METADATA,sha256=uP4EqAELc4jZkfQzBpPAOhEHHatPkfdBvO16OaQ7Wmk,11002
+env_use-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+env_use-1.0.0.dist-info/entry_points.txt,sha256=G9Q_GaxH_AZx89h3EzkBVAVUQ-ZwfAh3CO539_W3haE,45
+env_use-1.0.0.dist-info/RECORD,,

env_use-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

env_use-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+use-env = use_env.cli:main

use_env/__init__.py

@@ -0,0 +1,27 @@
+"""
+use-env: Environment file processor with extensible secret providers.
+
+This tool allows developers to define environment files with secret references
+that can be resolved from various providers (vault, environment variables, files, etc.).
+
+Basic Usage:
+    use-env .env.dev
+
+For more information, see:
+    https://github.com/yourusername/use-env
+"""
+
+from .cli import main
+from .config import UseEnvConfig
+from .loader import EnvLoader
+from .providers import Provider, ProviderError, ProviderRegistry
+
+__version__ = "1.0.0"
+__all__ = [
+    "main",
+    "UseEnvConfig",
+    "EnvLoader",
+    "Provider",
+    "ProviderRegistry",
+    "ProviderError",
+]