kiarina-lib-cloudflare

English | 日本語

Dependencies

A Cloudflare SDK is not included as a dependency. Add one to the application that uses the credentials.

Installation

pip install kiarina-lib-cloudflare

Features

• Configuring Cloudflare Authentication Store an account ID and API token as typed settings.
• Managing Multiple Accounts Switch between named settings for multiple accounts.
• Loading Environment Variables Load environment variables with the KIARINA_LIB_CLOUDFLARE_ prefix.
• Protecting API Tokens Store the API token as SecretStr.

Configuring Cloudflare Authentication

from kiarina.lib.cloudflare import CloudflareSettings

settings = CloudflareSettings(
    account_id="0123456789abcdef",
    api_token="secret-token",
)

Extract the token where it is needed to create a Cloudflare client.

account_id = settings.account_id
api_token = settings.api_token.get_secret_value()

Managing Multiple Accounts

settings_manager uses multiple-settings mode. Place named settings under configs.

kiarina.lib.cloudflare:
  default: production
  configs:
    development:
      account_id: development-account
      api_token: development-token
    production:
      account_id: production-account
      api_token: production-token

import yaml
from pydantic_settings_manager import load_user_configs

from kiarina.lib.cloudflare import settings_manager

with open("config.yaml", encoding="utf-8") as file:
    load_user_configs(yaml.safe_load(file) or {})

settings = settings_manager.get_settings("production")

To configure only this package directly, assign settings_manager.user_config.

from kiarina.lib.cloudflare import settings_manager

settings_manager.user_config = {
    "default": "development",
    "configs": {
        "development": {
            "account_id": "development-account",
            "api_token": "development-token",
        },
        "production": {
            "account_id": "production-account",
            "api_token": "production-token",
        },
    },
}

Loading Environment Variables

Load a single configuration from environment variables.

export KIARINA_LIB_CLOUDFLARE_ACCOUNT_ID="0123456789abcdef"
export KIARINA_LIB_CLOUDFLARE_API_TOKEN="secret-token"

from kiarina.lib.cloudflare import CloudflareSettings

settings = CloudflareSettings()

Protecting API Tokens

api_token is a SecretStr. Extract its value explicitly only where required.

api_token = settings.api_token.get_secret_value()

API Reference

kiarina.lib.cloudflare

from kiarina.lib.cloudflare import (
    CloudflareSettings,
    settings_manager,
)

CloudflareSettings

class CloudflareSettings(BaseSettings):
    def __init__(
        self,
        *,
        account_id: str,
        api_token: SecretStr,
    ) -> None: ...

Cloudflare account settings.

Fields

• account_id (str): Cloudflare account ID.
• api_token (SecretStr): Cloudflare API token.

settings_manager

settings_manager: SettingsManager[CloudflareSettings]

Global instance that manages named Cloudflare account settings.