ConfigCat Python SDK https://configcat.com
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
configcatclient
configcatclienttests
media
samples
.gitignore
.travis.yml
LICENSE
LICENSE.txt
MANIFEST.in
README.md
pytest.ini
requirements.txt
setup.cfg
setup.py
version_update.sh

README.md

ConfigCat SDK for Python

ConfigCat SDK for Python provides easy integration between ConfigCat service and applications using Python.

ConfigCat is a feature flag, feature toggle, and configuration management service. That lets you launch new features and change your software configuration remotely without actually (re)deploying code. ConfigCat even helps you do controlled roll-outs like canary releases and blue-green deployments. https://configcat.com

Build Status codecov PyPI PyPI Known Vulnerabilities License

Getting started

1. Install the package with pip

pip install configcat-client

2. Import configcatclient to your application

import configcatclient

3. Log in to ConfigCat Management Console and go to your Project to get your API Key:

API-KEY

4. Create a ConfigCat client instance:

configcat_client = configcatclient.create_client('#YOUR-API-KEY#')

We strongly recommend using the ConfigCat Client as a Singleton object in your application.

5. Get your setting value

isMyAwesomeFeatureEnabled = configcat_client.get_value('isMyAwesomeFeatureEnabled', False)
if isMyAwesomeFeatureEnabled:
    do_the_new_thing()
else:
    do_the_old_thing()

6. Stop ConfigCat client on application exit

configcat_client.stop()

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to the get_value() function.

Read more about Targeting here.

from configcatclient.user import User 

user = User('#USER-IDENTIFIER#')

isMyAwesomeFeatureEnabled = configcat_client.get_value('isMyAwesomeFeatureEnabled', False, user)
if isMyAwesomeFeatureEnabled:
    do_the_new_thing()
else:
    do_the_old_thing()

Sample/Demo apps

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

Support

If you need help how to use this SDK feel free to to contact the ConfigCat Staff on https://configcat.com. We're happy to help.

Contributing

Contributions are welcome.

About ConfigCat