Skip to main content

Python SDK for Quonfig — feature flags and configuration management

Project description

quonfig

Python SDK for Quonfig.

Install

pip install quonfig

Usage

from quonfig import Quonfig

client = Quonfig(sdk_key="sdk-...")
client.init()

value = client.get_string("my.key", default="fallback")
enabled = client.is_feature_enabled("my.flag")

Context

# Per-call context
result = client.get_string("my.key", contexts={"user": {"plan": "pro"}})

# Bound context (for request handlers etc.)
user_client = client.with_context({"user": {"id": "u123", "plan": "pro"}})
enabled = user_client.is_feature_enabled("my.flag")

# Thread-local scoped context
with client.scoped_context({"user": {"id": "u123"}}):
    enabled = client.is_feature_enabled("my.flag")

Dynamic log levels

from quonfig import Quonfig

client = Quonfig(
    sdk_key="sdk-...",
    logger_key="log-level.my-app",  # config that drives per-logger rules
).init()

# Convenience form — SDK injects { "quonfig-sdk-logging": { "key": "my_app.auth" } }
# into context so a single config can route by logger path.
if client.should_log(logger_path="my_app.auth", desired_level="INFO"):
    print("auth event")

# Primitive form — for callers that want explicit control over the config key.
# No auto-prefixing: pass the full stored key.
if client.should_log(config_key="log-level.my-app", desired_level="DEBUG"):
    print("debug event")

logger_path is passed through verbatim — the SDK does not normalize it, so callers can author config rules against whatever shape their host language prefers (dotted, double-colon, slash, etc.).

Dynamic log levels with stdlib logging

Attach QuonfigLoggerFilter to any logger or handler and the SDK will gate records against logger_key. The record's name flows into context verbatim as quonfig-sdk-logging.key, so a single config can drive per-logger rules.

import logging
from quonfig import Quonfig, QuonfigLoggerFilter

client = Quonfig(sdk_key="sdk-...", logger_key="log-level.my-app").init()

root = logging.getLogger()
root.addFilter(QuonfigLoggerFilter(client))

Dynamic log levels with structlog

QuonfigLoggerProcessor is a structlog processor. Place it after structlog.stdlib.add_log_level so the level is populated on the event dict.

import structlog
from quonfig import Quonfig, QuonfigLoggerProcessor

client = Quonfig(sdk_key="sdk-...", logger_key="log-level.my-app").init()

structlog.configure(
    processors=[
        structlog.stdlib.add_log_level,
        QuonfigLoggerProcessor(client),
        structlog.processors.JSONRenderer(),
    ],
)

structlog is an optional dependency — QuonfigLoggerProcessor raises ImportError with an install hint if it isn't available. The stdlib filter has no optional-dep concern.

Datadir mode (local files)

import os

client = Quonfig(datadir="/path/to/workspace", environment="production")
client.init()

Configuration

Param Env var Default
sdk_key QUONFIG_SDK_KEY required for API mode
api_urls -- (derived from QUONFIG_DOMAIN) ["https://primary.quonfig.com", "https://secondary.quonfig.com"]
telemetry_url -- (derived from QUONFIG_DOMAIN) https://telemetry.quonfig.com
environment QUONFIG_ENVIRONMENT ""
datadir QUONFIG_DIR None
init_timeout -- 10.0
on_init_failure -- "raise"
on_no_default -- "error"
logger_key -- None

QUONFIG_DOMAIN

A single env var governs the api, sse, and telemetry URL defaults:

Env var Default Effect
QUONFIG_DOMAIN quonfig.com Sets api_urls to https://primary.${DOMAIN} + https://secondary.${DOMAIN} and telemetry_url to https://telemetry.${DOMAIN}. SSE host is derived by prepending stream. to the api host.

Resolution order (highest wins):

  1. Explicit api_urls= / telemetry_url= kwargs (local-dev escape hatch).
  2. QUONFIG_DOMAIN env var.
  3. Hardcoded default quonfig.com.

The previously-supported QUONFIG_API_URL, QUONFIG_API_URLS, and QUONFIG_TELEMETRY_URL env vars have been removed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quonfig-0.0.13.tar.gz (33.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quonfig-0.0.13-py3-none-any.whl (39.1 kB view details)

Uploaded Python 3

File details

Details for the file quonfig-0.0.13.tar.gz.

File metadata

  • Download URL: quonfig-0.0.13.tar.gz
  • Upload date:
  • Size: 33.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.13

File hashes

Hashes for quonfig-0.0.13.tar.gz
Algorithm Hash digest
SHA256 0cb9a3e1846ac81f454ed179c11990fb517cc6176cbffd052fb328f18c2216ca
MD5 9681e384052c565e176af4835a478c3f
BLAKE2b-256 6f6312903cb4901143c7ad9eb33ee4d95e14adedd3a98e6bfb5ed60db0c5e038

See more details on using hashes here.

File details

Details for the file quonfig-0.0.13-py3-none-any.whl.

File metadata

  • Download URL: quonfig-0.0.13-py3-none-any.whl
  • Upload date:
  • Size: 39.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.13

File hashes

Hashes for quonfig-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 54c5756093bfd8602049070956d93bc4cb798245089e75520ddf3ae728695123
MD5 1a5b463ceb331549e0e4e2f541a9a553
BLAKE2b-256 c25f205d3f0c225f6ea41583032724fc067d58c685ed59dd9804a5306295b4e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page