Split Python SDK

Overview

This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split feature flag to manage your complete customer experience.

Compatibility

This SDK is compatible with Python 3.7 and higher.

Getting started

Below is a simple example that describes the instantiation and most basic usage of our SDK:

Run pip install splitio_client

from splitio import get_factory
from splitio.exceptions import TimeoutException
factory = get_factory('YOUR_SDK_TYPE_API_KEY', config=config)
try:
    factory.block_until_ready(5) # wait up to 5 seconds
    split = factory.client()
    treatment = split.get_treatment('CUSTOMER_ID', 'FEATURE_FLAG_NAME')
    if treatment == "on":
        # insert code here to show on treatment
    elif treatment == "off":
        # insert code here to show off treatment
    else:
        # insert your control treatment code here
except TimeoutException:
    # Now the user can choose whether to abort the whole execution, or just keep going
    # without a ready client, which if configured properly, should become ready at some point.
    pass

Please refer to our official docs to learn about all the functionality provided by our SDK and the configuration options available for tailoring it to your current application setup.

Submitting issues

The Split team monitors all issues submitted to this issue tracker. We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.

Contributing

Please see Contributors Guide to find all you need to submit a Pull Request (PR).

License

Licensed under the Apache License, Version 2.0. See: Apache License.

About Split

Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.

To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

.NET Github Docs
Android Github Docs
Angular Github Docs
GO Github Docs
iOS Github Docs
Java Github Docs
JavaScript Github Docs
JavaScript for Browser Github Docs
Node Github Docs
PHP Github Docs
Python Github Docs
React Github Docs
React Native Github Docs
Redux Github Docs
Ruby Github Docs

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.

splitio / python-client

readme