LaunchDarkly SDK for Python
Python
Permalink
Failed to load latest commit information.
demo
ldclient Update changelog + versions for 4.0.1 Jan 10, 2017
testing
.gitignore
CHANGELOG.md Update changelog + versions for 4.0.1 Jan 10, 2017
CONTRIBUTING.md
LICENSE.txt
MANIFEST.in Merge master Aug 16, 2016
NOTICE.txt
README.md
circle.yml
pytest.ini Api-breaking changes. Allow SDK key to be changed. Nov 4, 2016
redis-requirements.txt clean up uris, etc Jul 2, 2016
requirements.txt Lower future version for compatibility Nov 15, 2016
runtests.py
setup.py Update changelog + versions for 4.0.1 Jan 10, 2017
test-requirements.txt
twisted-requirements.txt Implement Twisted for LDD mode only Aug 16, 2016

README.md

LaunchDarkly SDK for Python

Circle CI PyPI PyPI Twitter Follow

Quick setup

  1. Install the Python SDK with pip

    pip install ldclient-py
    
  2. Configure the library with your sdk key:

    import ldclient
    
  3. Get the client:

    ldclient.set_sdk_key("your sdk key")
    client = ldclient.get()
    

Your first feature flag

  1. Create a new feature flag on your dashboard
  2. In your application code, use the feature's key to check whether the flag is on for each user:

    if client.variation("your.flag.key", {"key": "user@test.com"}, False):
        # application code to show the feature
    else:
        # the code to run if the feature is off
    

Twisted

Twisted is supported for LDD mode only. To run in Twisted/LDD mode,

  1. Use this dependency:

    ldclient-py[twisted]>=3.0.1
    
  2. Configure the client:

    feature_store = TwistedRedisFeatureStore(url='YOUR_REDIS_URL', redis_prefix="ldd-restwrapper", expiration=0)
    ldclient.config.feature_store = feature_store
    
    ldclient.config = ldclient.Config(
        use_ldd=use_ldd,
        event_consumer_class=TwistedEventConsumer,
    )
    ldclient.sdk_key = 'YOUR_SDK_KEY'
    
  3. Get the client:

    client = ldclient.get()

Learn more

Check out our documentation for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the complete reference guide for this SDK.

Testing

We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.

Contributing

See CONTRIBUTING for more information.

About LaunchDarkly

  • LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
    • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
    • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
    • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
    • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
  • LaunchDarkly provides feature flag SDKs for
  • Explore LaunchDarkly