Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 4.47 KB

README.md

File metadata and controls

91 lines (66 loc) · 4.47 KB
Raw

ConfigCat SDK for Python

https://configcat.com
ConfigCat SDK for Python provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Dashboard even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

Python CI codecov PyPI PyPI Known Vulnerabilities Vulnerabilities License

SonarCloud

Getting started

1. Install the package with pip

pip install configcat-client

2. Import configcatclient to your application

import configcatclient

3. Go to the ConfigCat Dashboard to get your SDK Key:

SDK-KEY

4. Create a ConfigCat client instance:

configcat_client = configcatclient.get('#YOUR-SDK-KEY#')

We strongly recommend you to use the ConfigCat Client as a Singleton object in your application. The configcatclient.get() static factory method constructs singleton client instances for your SDK keys.

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.close()

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.

Need help?

https://configcat.com/support

Contributing

Contributions are welcome. For more info please read the Contribution Guideline.

About ConfigCat