BetterConfig client for Python

BetterConfig is a cloud based configuration as a service. It integrates with your apps, backends, websites, and other programs, so you can configure them through this website even after they are deployed. https://betterconfig.com

Getting started

1. Install the BetterConfigClient-Python package with pip

pip install betterconfigclient-python

2. Import betterconfigclient to your application

import betterconfigclient

3. Get your Project Secret from the BetterConfig.com portal

4. Initialize and get the client

betterconfigclient.initialize('<PLACE-YOUR-PROJECT-SECRET-HERE>')
client = betterconfigclient.get()

5. Get your config value

isMyAwesomeFeatureEnabled = client.get_value('key-of-my-awesome-feature', False)
if isMyAwesomeFeatureEnabled:
    //show your awesome feature to the world!

6. On application exit:

betterconfigclient.stop()

Configuration

Client supports three different caching policies to acquire the configuration from BetterConfig. When the client fetches the latest configuration, puts it into the internal cache and serves any configuration acquisition from cache. With these caching policies you can manage your configurations' lifetimes easily.

Auto polling (default)

Client downloads the latest configuration and puts into a cache repeatedly. Use poll_interval_seconds parameter to manage polling interval. Use on_configuration_changed_callback parameter to get notification about configuration changes.

Lazy loading

Client downloads the latest configuration only when it is not present or expired in the cache. Use cache_time_to_live_seconds parameter to manage configuration lifetime.

Manual polling

With this mode you always have to call force_refresh() method to fetch the latest configuration into the cache. When the cache is empty (for example after client initialization) and you try to acquire any value you'll get the default value!

Initializing the client and the configuration parameters are different for each cache policy:

Auto polling

betterconfigclient.initialize(...)

Example - increase poll_interval_seconds to 600 seconds:

betterconfigclient.initialize('<PLACE-YOUR-PROJECT-SECRET-HERE>', poll_interval_seconds=600)

Example - get notification about configuration changes via on_configuration_changed_callback:

def configuration_changed_callback(self):
    # Configuration changed.
    pass
    
betterconfigclient.initialize('<PLACE-YOUR-PROJECT-SECRET-HERE>', on_configuration_changed_callback=configuration_changed_callback)

Lazy loading

betterconfigclient.initialize_lazy_loading(...)

Example - increase cache_time_to_live_seconds to 600 seconds:

betterconfigclient.initialize_lazy_loading('<PLACE-YOUR-PROJECT-SECRET-HERE>', cache_time_to_live_seconds=600)

Example - use a custom config_cache_class:

from betterconfigclient.interfaces import ConfigCache


class InMemoryConfigCache(ConfigCache):

    def __init__(self):
        self._value = None

    def get(self):
        return self._value

    def set(self, value):
        self._value = value

betterconfigclient.initialize_lazy_loading('<PLACE-YOUR-PROJECT-SECRET-HERE>', config_cache_class=InMemoryConfigCache)

Manual polling

betterconfigclient.initialize_manual_polling(...)

Example - call force_refresh() to fetch the latest configuration:

betterconfigclient.initialize_manual_polling('<PLACE-YOUR-PROJECT-SECRET-HERE>')
betterconfigclient.get().get_value('test_key', 'default_value') # This will return 'default_value' 
betterconfigclient.get().force_refresh()
betterconfigclient.get().get_value('test_key', 'default_value') # This will return the real value for key 'test_key'

Members

Methods

Logging

The BetterConfig client uses the default Python logging package for logging.

Sample projects

• Console sample
• Django web app sample