kiarina-lib-cloudflare-auth 1.4.0__py3-none-any.whl

kiarina/lib/cloudflare/auth/__init__.py

@@ -0,0 +1,30 @@
+import logging
+from importlib import import_module
+from importlib.metadata import version
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .settings import CloudflareAuthSettings, settings_manager
+
+__version__ = version("kiarina-lib-cloudflare-auth")
+
+__all__ = [
+    # .settings
+    "CloudflareAuthSettings",
+    "settings_manager",
+]
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+
+def __getattr__(name: str) -> object:
+    if name not in __all__:
+        raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
+
+    module_map = {
+        "CloudflareAuthSettings": ".settings",
+        "settings_manager": ".settings",
+    }
+
+    globals()[name] = getattr(import_module(module_map[name], __name__), name)
+    return globals()[name]

kiarina/lib/cloudflare/auth/settings.py

@@ -0,0 +1,12 @@
+from pydantic import SecretStr
+from pydantic_settings import BaseSettings
+from pydantic_settings_manager import SettingsManager
+
+
+class CloudflareAuthSettings(BaseSettings):
+    account_id: str
+
+    api_token: SecretStr
+
+
+settings_manager = SettingsManager(CloudflareAuthSettings, multi=True)

kiarina_lib_cloudflare_auth-1.4.0.dist-info/METADATA

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: kiarina-lib-cloudflare-auth
+Version: 1.4.0
+Summary: Cloudflare client library for kiarina namespace
+Project-URL: Homepage, https://github.com/kiarina/kiarina-python
+Project-URL: Repository, https://github.com/kiarina/kiarina-python
+Project-URL: Issues, https://github.com/kiarina/kiarina-python/issues
+Project-URL: Changelog, https://github.com/kiarina/kiarina-python/blob/main/packages/kiarina-lib-cloudflare-auth/CHANGELOG.md
+Project-URL: Documentation, https://github.com/kiarina/kiarina-python/tree/main/packages/kiarina-lib-cloudflare-auth#readme
+Author-email: kiarina <kiarinadawa@gmail.com>
+Maintainer-email: kiarina <kiarinadawa@gmail.com>
+License-Expression: MIT
+Keywords: cdn,client,cloud,cloudflare,pydantic,settings
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: pydantic-settings-manager>=2.1.0
+Requires-Dist: pydantic-settings>=2.10.1
+Description-Content-Type: text/markdown
+
+# kiarina-lib-cloudflare-auth
+
+A Python library for Cloudflare authentication with configuration management using pydantic-settings-manager.
+
+## Features
+
+- **Configuration Management**: Use `pydantic-settings-manager` for flexible configuration
+- **Type Safety**: Full type hints and Pydantic validation
+- **Secure Credential Handling**: API tokens are protected using `SecretStr`
+- **Multiple Configurations**: Support for multiple named configurations (e.g., different accounts)
+- **Environment Variable Support**: Configure via environment variables with `KIARINA_LIB_CLOUDFLARE_AUTH_` prefix
+
+## Installation
+
+```bash
+pip install kiarina-lib-cloudflare-auth
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from kiarina.lib.cloudflare.auth import CloudflareAuthSettings, settings_manager
+
+# Configure Cloudflare authentication
+settings_manager.user_config = {
+    "default": {
+        "account_id": "your-account-id",
+        "api_token": "your-api-token"
+    }
+}
+
+# Get settings
+settings = settings_manager.settings
+print(f"Account ID: {settings.account_id}")
+print(f"API Token: {settings.api_token.get_secret_value()}")  # Access secret value
+```
+
+### Environment Variable Configuration
+
+Configure authentication using environment variables:
+
+```bash
+export KIARINA_LIB_CLOUDFLARE_AUTH_ACCOUNT_ID="your-account-id"
+export KIARINA_LIB_CLOUDFLARE_AUTH_API_TOKEN="your-api-token"
+```
+
+```python
+from kiarina.lib.cloudflare.auth import settings_manager
+
+# Settings are automatically loaded from environment variables
+settings = settings_manager.settings
+print(f"Account ID: {settings.account_id}")
+```
+
+### Multiple Configurations
+
+Manage multiple Cloudflare accounts:
+
+```python
+from kiarina.lib.cloudflare.auth import settings_manager
+
+# Configure multiple accounts
+settings_manager.user_config = {
+    "production": {
+        "account_id": "prod-account-id",
+        "api_token": "prod-api-token"
+    },
+    "staging": {
+        "account_id": "staging-account-id",
+        "api_token": "staging-api-token"
+    }
+}
+
+# Switch between configurations
+settings_manager.active_key = "production"
+prod_settings = settings_manager.settings
+print(f"Production Account: {prod_settings.account_id}")
+
+settings_manager.active_key = "staging"
+staging_settings = settings_manager.settings
+print(f"Staging Account: {staging_settings.account_id}")
+```
+
+## Configuration
+
+This library uses [pydantic-settings-manager](https://github.com/kiarina/pydantic-settings-manager) for flexible configuration management.
+
+### CloudflareAuthSettings
+
+The `CloudflareAuthSettings` class provides the following configuration fields:
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `account_id` | `str` | Yes | Cloudflare account ID |
+| `api_token` | `SecretStr` | Yes | Cloudflare API token (masked in logs) |
+
+### Environment Variables
+
+All settings can be configured via environment variables with the `KIARINA_LIB_CLOUDFLARE_AUTH_` prefix:
+
+```bash
+# Account ID
+export KIARINA_LIB_CLOUDFLARE_AUTH_ACCOUNT_ID="your-account-id"
+
+# API Token (will be automatically wrapped in SecretStr)
+export KIARINA_LIB_CLOUDFLARE_AUTH_API_TOKEN="your-api-token"
+```
+
+### Programmatic Configuration
+
+```python
+from pydantic import SecretStr
+from kiarina.lib.cloudflare.auth import CloudflareAuthSettings, settings_manager
+
+# Direct settings object
+settings = CloudflareAuthSettings(
+    account_id="your-account-id",
+    api_token=SecretStr("your-api-token")
+)
+
+# Via settings manager
+settings_manager.user_config = {
+    "default": {
+        "account_id": "your-account-id",
+        "api_token": "your-api-token"  # Automatically converted to SecretStr
+    }
+}
+```
+
+### Runtime Overrides
+
+```python
+from kiarina.lib.cloudflare.auth import settings_manager
+
+# Override specific settings at runtime
+settings_manager.cli_args = {
+    "account_id": "override-account-id"
+}
+
+settings = settings_manager.settings
+print(f"Account ID: {settings.account_id}")  # Uses overridden value
+```
+
+## Security
+
+### API Token Protection
+
+API tokens are stored using Pydantic's `SecretStr` type, which provides the following security benefits:
+
+- **Masked in logs**: Tokens are displayed as `**********` in string representations
+- **Prevents accidental exposure**: Tokens won't appear in debug output or error messages
+- **Explicit access required**: Must use `.get_secret_value()` to access the actual token
+
+```python
+from kiarina.lib.cloudflare.auth import settings_manager
+
+settings = settings_manager.settings
+
+# Token is masked in string representation
+print(settings)  # api_token=SecretStr('**********')
+
+# Explicit access to get the actual token
+token = settings.api_token.get_secret_value()
+```
+
+## API Reference
+
+### CloudflareAuthSettings
+
+```python
+class CloudflareAuthSettings(BaseSettings):
+    account_id: str
+    api_token: SecretStr
+```
+
+Pydantic settings model for Cloudflare authentication.
+
+**Fields:**
+- `account_id` (str): Cloudflare account ID
+- `api_token` (SecretStr): Cloudflare API token (protected)
+
+### settings_manager
+
+```python
+settings_manager: SettingsManager[CloudflareAuthSettings]
+```
+
+Global settings manager instance for Cloudflare authentication.
+
+**Properties:**
+- `settings`: Get the current active settings
+- `user_config`: Get/set user configuration
+- `cli_args`: Get/set CLI arguments for runtime overrides
+- `active_key`: Get/set active configuration key (for multi-config mode)
+
+**Methods:**
+- `clear()`: Clear cached settings
+- `get_settings_by_key(key: str)`: Get settings by specific key
+
+## Development
+
+### Prerequisites
+
+- Python 3.12+
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/kiarina/kiarina-python.git
+cd kiarina-python
+
+# Setup development environment
+mise run setup
+```
+
+### Running Tests
+
+```bash
+# Run format, lint, type checks and tests
+mise run package kiarina-lib-cloudflare-auth
+
+# Coverage report
+mise run package:test kiarina-lib-cloudflare-auth --coverage
+```
+
+## Dependencies
+
+- [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/) - Settings management
+- [pydantic-settings-manager](https://github.com/kiarina/pydantic-settings-manager) - Advanced settings management
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](../../LICENSE) file for details.
+
+## Contributing
+
+This is a personal project, but contributions are welcome! Please feel free to submit issues or pull requests.
+
+## Related Projects
+
+- [kiarina-python](https://github.com/kiarina/kiarina-python) - The main monorepo containing this package
+- [pydantic-settings-manager](https://github.com/kiarina/pydantic-settings-manager) - Configuration management library used by this package

kiarina_lib_cloudflare_auth-1.4.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+kiarina/lib/cloudflare/auth/__init__.py,sha256=UILxUtBirbJjQutAJArE5iEzL7E0n7Ufj5fbYd1aoZs,779
+kiarina/lib/cloudflare/auth/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kiarina/lib/cloudflare/auth/settings.py,sha256=xbtp_4_5TAX45VWBVrxDCrIplQndQEYwFpsvcWP8uo0,293
+kiarina_lib_cloudflare_auth-1.4.0.dist-info/METADATA,sha256=6qE96rxyFmA2x86KJwd_s6oaSLv34ZPD0MOxwUEC42A,7985
+kiarina_lib_cloudflare_auth-1.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+kiarina_lib_cloudflare_auth-1.4.0.dist-info/RECORD,,

kiarina_lib_cloudflare_auth-1.4.0.dist-info/WHEEL

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