Python SDK

Welcome to the developer documentation for the Kameleoon Python SDK! Our SDK gives you the possibility of running experiments and activating feature flags on your back-end Python server. Integrating our SDK into your web-application is easy, and its footprint (in terms of memory and network usage) is low.

You can refer to the SDK reference to check out all possible features of the SDK. Also make sure you check out our Getting started tutorial which we have prepared to walk you through the installation and implementation.

Latest version of the Python SDK: 3.1.0 (changelog).

Getting started

This guide is designed to help you integrate our SDK in a few minutes and start running experiments in your Python applications. This tutorial will explain the setup of a simple A/B test to change the number of recommended products based on different variations.

Installing the SDK

Installing the Python client

pip install kameleoon-client-python

Installing the SDK can be directly achieved through an Python pip package. Our package is hosted on the official pip repository, so you just have to run the following command:

pip install kameleoon-client-python

Additional configuration

You should provide credentials for the Python SDK via a configuration file, which can also be used to customize the SDK behavior. A sample configuration file can be obtained here. We suggest to install this file to the default path of /etc/kameleoon/client-python.yaml, but you can also put it in another location and passing the path as an argument to the KameleoonClient() constructor method. With the current version of the Python SDK, those are the available keys:

client_id: a client_id is required for authentication to the Kameleoon service.
client_secret: a client_secret is required for authentication to the Kameleoon service.
refresh_interval_minute: specifies the refresh interval, in minutes, of the configuration for feature flags (the active feature flags are fetched from the Kameleoon servers). It means that once you launch an experiment, pause it, or stop it, the changes can take (at most) the duration of this interval to be propagated in production to your servers. If not specified, the default interval is 60 minutes.
session_duration_minute: sets the time interval that Kameleoon stores the visitor and their associated data in memory (RAM). Note that increasing the session duration increases the amount of RAM that needs to be allocated to store visitor data. The default session duration is 30 minutes.
default_timeout_millisecond: specifies the timeout, in milliseconds for network requests from the SDK. It is recommended to set the value to 30 seconds or more if you do not have a stable connection. The default value is 10 seconds. Some methods have their own parameters for timeouts, but if you do not specify them explicitly, this value is used.
top_level_domain: the current top-level domain for your website. Use the format:example.com. Don't include https://, www, or other subdomains. Kameleoon uses this information to set the corresponding cookie on the top-level domain. This field is mandatory.
environment: an option specifying which feature flag configuration will be used, by default each feature flag is split into production, staging, development. If not specified, will be set to default value of production. More information
multi_threading: an option of type bool indicating whether threads can be used for network requests. By default, the option is False and everything is executed in one thread to avoid performance issues with GIL if (C)Python interpreter is using. Possible values: True , False.

Alternatively, you can use configuration_object of type KameleoonClientConfig as parameter during initializaion. It has the same list of arguments as a config file. configuration_object takes precedence over the configuration file and overwrites the settings from it.

Initializing the Kameleoon client

from kameleoon import KameleoonClient, KameleoonClientConfig, KameleoonClientFactory

SITE_CODE = 'a8st4f59bj'

# Option 1
kameleoon_client = KameleoonClientFactory.create(SITE_CODE, config_path='/etc/kameleoon/client-python.yaml')

# Option 2
configuration_object = KameleoonClientConfig.read_from_yaml('/etc/kameleoon/client-python.yaml')
configuration_object.set_logger(my_logger)
kameleoon_client = KameleoonClientFactory.create(SITE_CODE, configuration_object)

# Option 3
configuration_object = KameleoonClientConfig(
    "client-id",  # required
    "client-secret",  # required
    refresh_interval_minute=60,  # (in minutes) optional, default: 60 minutes
    session_duration_minute=30,  # (in minutes) optional, default: 30 minutes
    default_timeout_millisecond=10000,  # (in milliseconds) optional, default: 10000 milliseconds
    environment="production",  # optional, possible values: "production" / "staging" / "development" / "staging", default: None
    top_level_domain="example.com",
    multi_threading=False,  # optional, default: False
    logger=my_logger,  # optional, default: standard kameleoon logger
)
kameleoon_client = KameleoonClientFactory.create(SITE_CODE, configuration_object)

After installing the SDK into your application, configuring the correct credentials (in /etc/kameleoon/client-python.yaml) and setting up a server-side experiment on Kameleoon's back-office, the next step is to create the Kameleoon client in your application code.

The code on the right gives a clear example. A KameleoonClient is a singleton object that acts as a bridge between your application and the Kameleoon platform. It includes all the methods and properties you will need to run an experiment.

note

It's the developers' responsability to ensure proper logic of their application code within the context of A/B testing via Kameleoon. A good practice is to always assume that the current visitor can be left out of the experiment because the experiment has not yet been launched. This is actually easy to do, because this corresponds to the implementation of the default / reference variation logic, which should be done in any case. The code samples on the next paragraph show examples of such an approach.

Using the Kameleoon Python SDK in a Django environment

If you use Django, we recommend you to initialize the Kameleoon client at server start-up, in the apps.py file of your Django application.

When you use python manage.py runserver Django start two processes, one for the actual development server and other to reload your application when the code change.

You can also start the server without the reload option, and you will see only one process running will only be executed once :

python manage.py runserver --noreload

You can also just check the RUN_MAIN env var in the ready() method itself.

def ready(self):
    if os.environ.get('RUN_MAIN', None) == 'true':
        configuration_path = os.path.join(ROOT_DIR, 'path_to_config', 'config.yml')
        self.kameleoon_client = KameleoonClientFactory.create(SITE_CODE, config_path=configuration_path)

This only applies to local development when you use python manage.py runserver. In a production environment, the code in the ready() function will be executed only one time when the application is initialized.

from django.apps import apps

my_application = apps.get_app_config('your_app')
client = my_application.kameleoon_client

You can then access the Kameleoon client in your application.

note

Another advantage of using Django is that the SDK will automatically be able to read and write the visitor_code on the HTTP request / response via a cookie. If you're using another framework in a web environment where you would like to use a cookie mechanism to persist the visitor_code, you will have to provide implementations of the read_cookies() and write_cookies() methods.

Technical considerations

Kameleoon made an important architectural design decision with its SDK technology, namely that every SDK must comply with a zero latency policy. In practice, this means that any blocking remote server call is banned, as even the fastest remote call would add a 20ms latency to your application. And if for any reason our servers are slower to reply than usual (unfortunately, this can happen), this delay can quickly increase to hundreds of milliseconds, seconds... or even completely block the load of the web page for the end user. We believe that web performance is of paramount importance in today's world and we don't think adding server-side A/B testing or feature flagging capabilities should come at the cost of an increased web page rendering time. For this reason, we guarantee that the use of our SDKs has absolutely no impact on the performance of the host platform.

However, having a zero latency policy does impose some constraints. The main one is that user data about your visitor should be kept locally, and not fetched from a remote server. For instance, if you set a custom data for a given visitor, we must store this somehow in your server / infrastructure, not on our (remote) side.

In the case of the Python SDK, this is implemented via a hash of visitor data (where keys are the visitor_codes) directly on RAM. So if you use CustomData() and then kameleoon_client.add_data() methods, the information will be stored in the application's RAM (the one hosting the SDK, usually an application server). The map is regularly cleaned (old visitors data is erased) so it should usually not grow too big in size, unless you have a very big traffic and use lots of custom data.

caution

Since the visitor data is kept in RAM, it is obviously lost if you restart your application server. This is usually not an issue, as important custom data is usually fetched from persistent database and then tagged on the current visitor. A reboot should thus only affect the Kameleoon custom data of the sessions active when the reboot occured.

Overview

When you update your feature flag configuration, the SDK can get it in two different ways. The first - polling - consists in retrieving the configuration at regular intervals. The second - streaming - is to retrieve the new configuration immediately.

Polling

This mode of obtaining the configuration is used by default. The SDK will send a request to Cloudflare CDN at regular intervals to retrieve the configuration. If you have not set an interval in the SDK configuration, the configuration in SDK will be refreshed every 60 minutes. It can be configured with refresh_interval_minute parameter.

Benefits:

When intervals are moderately spaced, this way of updating configuration consumes nominal memory and network resources.

Streaming

This mode allows the SDK to automatically take into account the new configuration without delay. When turned on, Kameleoon SDK is notified of any changes to the configuration in real-time, thanks to server-sent events (SSE).

Benefits:

Makes it possible to propagate and apply a new configuration in real-time.
Reduce network traffic compared to polling at short intervals, as streaming does not require sending periodic requests. It opens the connection once and then keeps it permanently open and ready to receive data.

If you rely on instant data updates (real-time), then streaming is for you. If you wish to activate this mode, please contact us.

Reference

This is a full reference documentation of the Python SDK.

KameleoonClientFactory

create

kameleoon_config = KameleoonClientConfig("client-id", "client-secret")
kameleoon_client = KameleoonClientFactory.create("a8st4f59bj", kameleoon_config)

kameleoon_client = KameleoonClientFactory.create("a8st4f59bj", config_path="/etc/kameleoon/client-ruby.yaml")

To start using the SDK, you need to complete the initialization first. All interactions with the SDK are completed through an object named Kameleoon::KameleoonClient, so the first thing you need to do is create this object.

Arguments

Name	Type	Description
site_code	str	Kameleoon site code for the website you want to run experiments on. This field is required.
config	KameleoonClientConfig	Configuration SDK object that you can pass instead of using a configuration file. This field is optional.
config_path	str	Path to the SDK configuration file. This field is optional. The default value is `/etc/kameleoon/client-ruby.yaml`

Exceptions thrown

Type	Description
SiteCodeIsEmpty	Exception indicating that the specified site code is empty string, which is an invalid value.
ConfigFileNotFound	Exception indicating that the configuration file was not found.

forget

SITE_CODE = "a8st4f59bj"
KameleoonClientFactory.forget(SITE_CODE)

The forget method removes a KameleoonClient instance from the KameleoonClientFactory with the specified site_code and frees resources used by the KameleoonClient instance. The KameleoonClient instance must not be used after calling the forget method.

Arguments

Name	Type	Description
site_code	str	Kameleoon site code for the website you want to run experiments on. This field is required.

KameleoonClient

wait_init_async

kameleoon_client = KameleoonClientFactory.create('a8st4f59bj')

if await kameleoon_client.wait_init_async():
    # The SDK has been initialized, you can fetch a feature flag / experiment configuration here.

wait_init_async asynchronously waits for the initialization of the Kameleoon client. This method allows you to check if the client has been successfully initialized before proceeding with other operations.

Return value

Type	Description
Coroutine[Any, Any, bool]	A coroutine that returns `True` if the Kameleoon client instance was successfully initialized, otherwise `False`.

wait_init

kameleoon_client = KameleoonClientFactory.create('a8st4f59bj')

if kameleoon_client.wait_init():
    # The SDK has been initialized, you can fetch a feature flag / experiment configuration here.

wait_init synchronously waits for initialization of the Kameleoon client. This method allows you to check if the client has been successfully initialized before proceeding with other operations.

Return value

Type	Description
bool	`True` if the Kameleoon client instance was successfully initialized, otherwise `False`.

get_visitor_code

### if you use KameleoonWSGIMiddleware service
visitor_code = kameleoon_client.get_visitor_code(cookies_readonly=request.COOKIES)
kameleoon_client.set_legal_consent(visitor_code, True)

### if you want to manage cookies manually
simple_cookies = SimpleCookie()
simple_cookies.load(cookie_header)

visitor_code = kameleoon_client.get_visitor_code(cookies=simple_cookies, default_visitor_code=default_visitor_code)

cookie_header = simple_cookies.output()

note

This method was previously named obtain_visitor_code , which was removed in SDK version 3.0.0.

The get_visitor_code() helper method should be called to obtain the Kameleoon visitor_code for the current visitor. This is especially important when using Kameleoon in a mixed front-end and back-end environment, where user identification consistency must be guaranteed. The implementation logic is described here:

First we check if a kameleoonVisitorCode cookie or query parameter associated with the current HTTP request can be found. If so, we will use this as the visitor identifier.
If no cookie / parameter is found in the current request, we either randomly generate a new identifier, or use the default_visitor_code argument as identifier if it is passed. This allows our customers to use their own identifiers as visitor codes, should they wish to. This can have the added benefit of matching Kameleoon visitors with their own users without any additional look-ups in a matching table.
In any case, the server-side (via HTTP header) kameleoonVisitorCode cookie is set with the value. Then this identifier value is finally returned by the method.

note

If you provide your own visitor_code, its uniqueness must be guaranteed on your end. The SDK doesn't validate the value passed as an argument. Also note that the length of visitor_code is limited to 255 characters. A VisitorCodeInvalid exception is raised if this limit is exceeded.

Arguments

Name	Type	Description
cookies_readonly	Optional[Dict[str, str]]	Readonly dictionary, usually `request.COOKIES`. Use this parameter if you also use the `KameleoonWSGIMiddleware` service. This field is optional.
cookies	Optinal[Dict[str, http.cookies.Morsel[str]]]	Pass cookies on the current HTTP request as a`Dict[str, http.cookies.Morsel[str]]` or `http.cookies.SimpleCookie[str]` object if you manage cookies manually (without `KameleoonWSGIMiddleware` service). This field is optional.
default_visitor_code	str	This parameter will be used as the visitor_code if no existing kameleoonVisitorCode cookie is found on the request. This field is optional, and by default a random visitor_code will be generated.

Return value

Type	Description
str	A visitor_code that will be associated with this particular user and should be used with most of the methods of the SDK.

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

is_feature_active

visitor_code = kameleoon_client.get_visitor_code(request.COOKIES)
feature_key = "new_checkout"
has_new_checkout = False

try
    has_new_checkout = kameleoon_client.is_feature_active(visitor_code, feature_key)
except FeatureNotFound as ex:
    # The user will not be counted into the experiment,
    # but should see the reference variation
    has_new_checkout = False
except VisitorCodeInvalid as ex:
    # The visitor code which you passed to the method isn't valid and can't be accepted by SDK
    has_new_checkout = False

if has_new_checkout
    # Implement new checkout code here

note

Previously named: activate_feature - deprecated since SDK version 2.1.0 and will be removed in a future releases.

To check if feature flag is active for a visitor, call the is_feature_active() method of our SDK.

This method takes a visitor_code and feature_key as mandatory arguments to check if the specified feature will be active for a given user.

If such a user has never been associated with this feature flag, the SDK returns a boolean value randomly (true if the user should have this feature or false if not). If a user with a given visitor_code is already registered with this feature flag, it will detect the previous feature flag value.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

Arguments

Name	Type	Description
visitor_code	str	Unique identifier of the user. This field is mandatory.
feature_key	str	ID or Key of the feature you want to expose to a user. This field is mandatory.

Return value

Type	Description
bool	Value of the feature that is registered for a given visitor_code.

Exceptions thrown

Type	Description
FeatureNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon's side (but code implementing the feature is already deployed on the web-application's side).
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).

get_feature_variation_key

visitor_code = kameleoon_client.get_visitor_code(request.COOKIES)

feature_key = "feature_key"
variation_key = ""

try
    variation_key = kameleoon_client.get_feature_variation_key(visitor_code, feature_key)
    if variation_key == 'on':
        # main variation key is selected for visitorCode
    elif variation_key == 'alternative_variation':
        # alternative variation key
    else:
        # default variation key
except FeatureNotFound as ex:
    # The user will not be counted into the experiment, but should see the reference variation
except VisitorCodeInvalid as ex:
    # The visitor code which you passed to the method isn't valid and can't be accepted by SDK
except FeatureEnvironmentDisabled as ex:
    # The feature flag is disabled for certain environments

To get feature variation key, call the get_feature_variation_key method of our SDK.

This method takes a visitor_code and feature_key as mandatory arguments to get variation key for a given user.

If such a user has never been associated with this feature flag, the SDK returns a variation key randomly (according to the feature flag rules). If a user with a given visitor_code is already registered with this feature flag, it will detect the previous variation key value. If the user does not match any of the rules, the default value will be returned, which we can define in your customer's account.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

Arguments

Name	Type	Description
visitor_code	string	Unique identifier of the user. This field is mandatory.
feature_key	string	Key of the feature you want to expose to a user. This field is mandatory.

Return value

Type	Description
string	Variation key of the feature flag that is registered for a given visitor_code.

Exceptions thrown

Type	Description
FeatureNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon's side (but code implementing the feature is already deployed on the web-application's side).
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).
FeatureEnvironmentDisabled	Exception indicating that the feature flag is disabled for certain environments.

get_feature_variable

visitor_code = kameleoon_client.get_visitor_code(request.COOKIES)

feature_key = "feature_key"
variable_key = "variable_key"
variation_value = ""

try:
    variable_value = kameleoon_client.get_feature_variable(visitor_code, feature_key, variable_key)
except FeatureNotFound as ex:
    # The user will not be counted into the experiment, but should see the reference variation
except FeatureVariableNotFound as ex:
    # Requested variable not defined on Kameleoon's side
except VisitorCodeInvalid as ex:
    # The visitor code which you passed to the method isn't valid and can't be accepted by SDK
except FeatureEnvironmentDisabled as ex:
    # The feature flag is disabled for certain environments

# your custom code depending of variable_value, e.g.
if variable_value == "value-1":
    # your custom code if variable == 'value-1'
elif variable_value == "value-2":
    # your custom code if variable == 'value-2'
else:
    # ...

note

Previously named: obtain_feature_variable , which was removed in SDK version 3.0.0.

To get variable of variation key associated with a user, call the get_feature_variable method of our SDK.

This method takes a visitor_code, feature_key and variable_key as mandatory arguments to get a variable of variation key for a given user.

If such a user has never been associated with this feature flag, the SDK returns a variable value of variation key randomly (according to the feature flag rules). If a user with a given visitor_code is already registered with this feature flag, it will detect the variable value for previous associated variation. If the user does not match any of the rules, the variable of default value will be returned.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

Arguments

Name	Type	Description
visitor_code	string	Unique identifier of the user. This field is mandatory.
feature_key	string	Key of the feature you want to expose to a user. This field is mandatory.
variable_key	string	Name of the variable you want to get a value. This field is mandatory.

Return value

Type	Description
Union[bool, str, float, Dict[str, Any], List[Any], None]	Value of variable of variation that is registered for a given visitor_code for this feature flag. Possible types: bool, float, str, List, Dict, None

Exceptions thrown

Type	Description
FeatureNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon's side (but code implementing the feature is already deployed on the web-application's side).
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).
FeatureVariableNotFound	Exception indicating that the requested variable has not been found. Check that the variable's key matches the one in your code.
FeatureEnvironmentDisabled	Exception indicating that the feature flag is disabled for certain environments.

get_feature_variation_variables

feature_key = "myFeature"

try
    data = kameleoon_client.get_feature_variation_variables(feature_key)
except FeatureNotFound as ex:
    # The feature is not yet activated on Kameleoon's side
except FeatureEnvironmentDisabled as ex:
    # The feature flag is disabled for certain environments

note

Previously named: get_feature_all_variables, which was removed in SDK version 3.0.0.

To retrieve the all feature variables, call the get_feature_variation_variables method of our SDK. A feature variable can be changed easily via our web application.

This method takes one input parameter: feature_key. It will return the data with the Dict[str,Any] type, as defined on the web interface. It will throw an exception (FeatureNotFound) if the requested feature has not been found in the internal configuration of the SDK.

Arguments

Name	Type	Description
feature_key	String	Key of the feature you want to obtain to a user. This field is mandatory.

Return value

Type	Description
Dict[str, Any]	Data associated with this feature flag. The values of can be a int, str, bool or Dict or List (depending on the type defined on the web interface).

Exceptions thrown

Type	Description
FeatureNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon''s side.
FeatureEnvironmentDisabled	Exception indicating that the feature flag is disabled for certain environments.

track_conversion

require "kameleoon"
require "kameleoon/data"

visitor_code = kameleoon_client.get_visitor_code(request.COOKIES)
goal_id = 83023

kameleoon_client.add_data(visitor_code, Browser(BrowserType.CHROME))
kameleoon_client.add_data(
    visitor_code,
    PageView("https://url.com", "title", [3]),
    CustomData(2, "value")
)
kameleoon_client.add_data(visitor_code, Conversion(32, 10, false))
kameleoon_client.track_conversion(visitor_code, goal_id)

To track conversion, use the track_conversion() method. This method requires visitor_code and goal_id to track conversion on this particular goal. In addition, this method also accepts revenue as a third optional argument to track revenue. The visitor_code is usually identical to the one that was used when triggering the experiment.

The track_conversion() method doesn't return any value. This method is non-blocking as the server call is made asynchronously if multi_threading is True

Arguments

Name	Type	Description
visitor_code	String	Unique identifier of the user. This field is mandatory.
goal_id	Integer	ID of the goal. This field is mandatory.
revenue	Float	Revenue of the conversion. This field is optional.

add_data

require "kameleoon"
require "kameleoon/data"

visitor_code = kameleoon_client.get_visitor_code(request.COOKIES)

kameleoon_client.add_data(visitor_code, Browser(BrowserType.CHROME))
kameleoon_client.add_data(
    visitor_code,
    PageView("https://url.com", "title", [3]),
    CustomData(0, "value")
)
kameleoon_client.add_data(visitor_code, Conversion(32, 10, false))

The add_data() method adds targeting data to storage so other methods can use the data to decide whether or not to target the current visitor.

The add_data() method does not return any value and does not interact with Kameleoon back-end servers on its own. Instead, all the declared data is saved for future transmission using the flush method. This approach reduces the number of server calls made, as the data is typically grouped into a single server call that is triggered the flush. Note that the track_conversion method also sends out any previously associated data, just like the flush method. The same is true for get_feature_variation_key and get_feature_variable methods if an experimentation rule is triggered.

tip

Each visitor can only have one instance of associated data for most data types. However, CustomData is an exception. Visitors can have one instance of associated CustomData per index.

Arguments

Name	Type	Description
visitor_code	String	Unique identifier of the user. This field is mandatory.
data_types	KameleoonData	Custom data types which may be passed separated by a comma.

flush

require "kameleoon"
require "kameleoon/data"

visitor_code = kameleoon_client.get_visitor_code(request.COOKIES)

kameleoon_client.add_data(visitor_code, Browser(BrowserType.CHROME))
kameleoon_client.add_data(
    visitor_code,
    PageView("https://url.com", "title", [3]),
    CustomData(0, "value")
)
kameleoon_client.add_data(visitor_code, Conversion(32, 10, false))

kameleoon_client.flush(visitor_code)

Data associated with the current user via add_data() method is not immediately sent to the server. It is stored and accumulated until it is sent automatically by the track_conversion() method, or manually by the flush() method. This allows the developer to control exactly when the data is flushed to our servers. For instance, if you call the add_data() method a dozen times, it would be a waste of ressources to send data to the server after each add_data() invocation. Just call flush() once at the end.

The flush() method doesn't return any value. This method is non-blocking as the server call is made asynchronously if multi_threading is True

Arguments

Name	Type	Description
visitor_code	String	Unique identifier of the user. This field is mandatory.

get_feature_list

all_feature_list = kameleoon_client.get_feature_list()

note

Previously named: obtain_feature_list , which was removed in SDK version 3.0.0.

Returns a list of feature flag keys currently available for the SDK

Return value

Type	Description
List[str]	List of feature flag's keys

get_active_feature_list_for_visitor

active_feature_flag_for_visitor = kameleoonClient.get_active_feature_list_for_visitor(visitor_code)

note

Previously named: obtain_feature_list , which was removed in SDK version 3.0.0.

This method takes only input parameters: visitorCode. Result contains only active feature flags for a given visitor.

Arguments

Name	Type	Description
visitor_code	str	Unique identifier of the user. This field is optional.

Return value

Type	Description
List[str]	List of feature flag keys which are active for a given visitor_code

get_remote_data

    kameleoon_client.get_remote_data('key1') # default timeout

    kameleoon_client.get_remote_data('key2', 1.0) # 1 second timeout

note

If you want to retrieve the data asynchronously, use the get_remote_data_async method instead (available since version 2.3.0).

note

Previously named: retrieve_data_from_remote_source , which was removed in SDK version 3.0.0.

The get_remote_data method allows you to retrieve data synchronously (according to a key passed as argument) for specified site_code (specified with KameleoonClient.__init__) stored on a remote Kameleoon server. Usually data will be stored on our remote servers via the use of our Data API. This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way to quickly store massive amounts of data that can be later retrieved for each of your visitors / users.

Arguments

Name	Type	Description
key	str	The key that the data you try to get is associated with. This field is mandatory.
timeout	Optional[float]	Timeout (in seconds). This parameter specifies the maximum amount of time the method can block to wait for a result. This field is optional, if not provided, it will use the `default_timeout_millisecond` value from configuration file or 2 seconds if it's not specified in the file.

Return value

Type	Description
JSON object	JSON object associated with retrieving data for specific key.

get_remote_data_async

    await kameleoon_client.get_remote_data_async('key1') # default timeout

    await kameleoon_client.get_remote_data_async('key2', 1.0) # 1 second timeout

The get_remote_data_async method allows you to retrieve data asynchronously (according to a key passed as argument) for specified site_code (specified with KameleoonClient.__init__) stored on a remote Kameleoon server. Usually data will be stored on our remote servers via the use of our Data API. This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way to quickly store massive amounts of data that can be later retrieved for each of your visitors / users.

Arguments

Name	Type	Description
key	str	The key that the data you try to get is associated with. This field is mandatory.
timeout	Optional[float]	Timeout (in seconds). This parameter specifies the maximum amount of time the method can block to wait for a result. This field is optional, if not provided, it will use the `default_timeout_millisecond` value from configuration file or 2 seconds if it's not specified in the file.

Return value

Type	Description
JSON object	JSON object associated with retrieving data for specific key.

get_remote_visitor_data

The get_remote_visitor_data method allows you to synchronously retrieve custom data stored on remote Kameleoon servers for a visitor (specified using the visitor_code argument). If add_data is True, this method automatically adds the retrieved data to a visitor without requiring you to make a separate add_data call.

You must have previously stored data on our remote servers, which you can add with any of the following tracking calls in the SDK:

flush
get_feature_variation_key
get_feature_variable
is_feature_active

Using the get_remote_visitor_data method along with the availability of our highly scalable servers provides a convenient way to quickly access and synchronize large amounts of data across all of the visitor's devices.

note

If you want to retrieve the data asynchronously, use the get_remote_visitor_data_async method instead.

Arguments

Name	Type	Description
visitor_code	str	The visitor code for which you want to retrieve the assigned data. This field is mandatory.
add_data	bool	A boolean indicating whether the method should automatically add retrieved data for a visitor. If not specified, the default value is True. This field is optional.
timeout	Optional[float]	Timeout (in seconds). This parameter specifies the maximum amount of time the method can block to wait for a result. This field is optional, if not provided, it will use the `default_timeout_millisecond` value from configuration file or 2 seconds if it's not specified in the file.

Return value

Type	Description
List[Data]	A list of data assigned to the given visitor.

Example code

    visitor_code = 'visitorCode'

    # Visitor data will be fetched and automatically added for `visitor_code`
    data_list = kameleoon_client.get_remote_visitor_data(visitor_code)  # default timeout
    data_list = kameleoon_client.get_remote_visitor_data(visitor_code, timeout=1.0)  # 1 second timeout

    # If you only want to fetch data and add it yourself manually, set `add_data` to `False`
    data_list = kameleoon_client.get_remote_visitor_data(visitor_code, False)  # default timeout
    data_list = kameleoon_client.get_remote_visitor_data(visitor_code, False, 1.0)  # 1 second timeout

get_remote_visitor_data_async

The get_remote_visitor_data_async method allows you to asynchronously retrieve custom data stored on remote Kameleoon servers for a visitor (specified using the visitor_code argument). If add_data is True, this method automatically adds the retrieved data to a visitor without requiring you to make a separate add_data call.

You must have previously stored data on our remote servers, which you can add with any of the following tracking calls in the SDK:

flush
get_feature_variation_key
get_feature_variable
is_feature_active

Arguments

Name	Type	Description
visitor_code	str	The visitor code for which you want to retrieve the assigned data. This field is mandatory.
add_data	bool	A boolean indicating whether the method should automatically add retrieved data for a visitor. If not specified, the default value is True. This field is optional.
timeout	Optional[float]	Timeout (in seconds). This parameter specifies the maximum amount of time the method can block to wait for a result. This field is optional, if not provided, it will use the `default_timeout_millisecond` value from configuration file or 2 seconds if it's not specified in the file.

Return value

Type	Description
List[Data]	A list of data assigned to the given visitor.

Example code

    visitor_code = 'visitorCode'

    # Visitor data will be fetched and automatically added for `visitor_code`
    data_list = await kameleoon_client.get_remote_visitor_data_async(visitor_code)  # default timeout
    data_list = await kameleoon_client.get_remote_visitor_data_async(visitor_code, timeout=1.0)  # 1 second timeout

    # If you only want to fetch data and add it yourself manually, set `add_data` to `False`
    data_list = await kameleoon_client.get_remote_visitor_data_async(visitor_code, False)  # default timeout
    data_list = await kameleoon_client.get_remote_visitor_data_async(visitor_code, False, 1.0)  # 1 second timeout

get_visitor_warehouse_audience

Synchronously retrieves all audience data associated with the visitor in your data warehouse using the specified visitor_code and warehouse_key. The warehouse_key is typically your internal user ID. The custom_data_index parameter corresponds to the Kameleoon custom data that Kameleoon uses to target your visitors. You can refer to the warehouse targeting documentation for additional details. The method returns a CustomData object, confirming that the data has been added to the visitor and is available for targeting purposes.

note

If you want to retrieve the data asynchronously, use the get_visitor_warehouse_audience_async method instead.

Arguments

Name	Type	Description
visitor_code	str	A unique visitor identification string, can't exceed 255 characters length. This field is mandatory.
custom_data_index	int	An integer representing the index of the custom data you want to use to target your BigQuery Audiences. This field is mandatory.
warehouse_key	Optional[str]	A unique key to identify the warehouse data (usually, your internal user ID). This field is optional.
timeout	Optional[float]	Timeout (in seconds). This parameter specifies the maximum amount of time to wait for a result. This field is optional. If not provided, the default value is 10 seconds.

Return value

Type	Description
Optional[CustomData]	A `CustomData` instance confirming that the data has been added to the visitor.

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

Example code

try:
    warehouse_audience_data = kameleoon_client.\
        get_visitor_warehouse_audience(visitor_code, custom_data_index)  # default timeout
    warehouse_audience_data = kameleoon_client.\
        get_visitor_warehouse_audience(visitor_code, custom_data_index, timeout=1.0)  # 1 second timeout

    warehouse_audience_data = kameleoon_client.\
        get_visitor_warehouse_audience(visitor_code, custom_data_index, warehouse_key)  # default timeout
    warehouse_audience_data = kameleoon_client.\
        get_visitor_warehouse_audience(visitor_code, custom_data_index, warehouse_key, 1.0)  # 1 second timeout

    # Your custom code
except VisitorCodeInvalid as e:
    # Handle exception

get_visitor_warehouse_audience_async

Asynchronously retrieves all audience data associated with the visitor in your data warehouse using the specified visitor_code and warehouse_key. The warehouse_key is typically your internal user ID. The custom_data_index parameter corresponds to the Kameleoon custom data that Kameleoon uses to target your visitors. You can refer to the warehouse targeting documentation for additional details. The method returns a CustomData object, confirming that the data has been added to the visitor and is available for targeting purposes.

Arguments

Name	Type	Description
visitor_code	str	A unique visitor identification string, can't exceed 255 characters length. This field is mandatory.
custom_data_index	int	An integer representing the index of the custom data you want to use to target your BigQuery Audiences. This field is mandatory.
warehouse_key	Optional[str]	A unique key to identify the warehouse data (usually, your internal user ID). This field is optional.
timeout	Optional[float]	Timeout (in seconds). This parameter specifies the maximum amount of time to wait for a result. This field is optional. If not provided, the default value is 10 seconds.

Return value

Type	Description
Optional[CustomData]	A `CustomData` instance confirming that the data has been added to the visitor.

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

Example code

try:
    warehouse_audience_data = await kameleoon_client.\
        get_visitor_warehouse_audience_async(visitor_code, custom_data_index)  # default timeout
    warehouse_audience_data = await kameleoon_client.\
        get_visitor_warehouse_audience_async(visitor_code, custom_data_index, timeout=1.0)  # 1 second timeout

    warehouse_audience_data = await kameleoon_client.\
        get_visitor_warehouse_audience_async(visitor_code, custom_data_index, warehouse_key)  # default timeout
    warehouse_audience_data = await kameleoon_client.\
        get_visitor_warehouse_audience_async(visitor_code, custom_data_index, warehouse_key, 1.0)  # 1 second timeout

    # Your custom code
except VisitorCodeInvalid as e:
    # Handle exception

get_engine_tracking_code

engine_tracking_code = kameleoon_client.get_engine_tracking_code(visitor_code)
# The following string will be returned:
#
# window.kameleoonQueue = window.kameleoonQueue || [];
# window.kameleoonQueue.push(['Experiments.assignVariation', experiment1ID, variation1ID]);
# window.kameleoonQueue.push(['Experiments.trigger', experiment1ID, true]);
# window.kameleoonQueue.push(['Experiments.assignVariation', experiment2ID, variation2ID]);
# window.kameleoonQueue.push(['Experiments.trigger', experiment2ID, true]);
#
# Here, experiment1ID, experiment2ID and variation1ID, variation2ID represent
# the specific experiments and variations that users have been assigned to.

Kameleoon offers built-in integrations with various analytics solutions, such as Mixpanel, Google Analytics 4, Segment... To ensure that you can track and analyze your server-side experiments, Kameleoon provides a method getEngineTrackingCode() that allows you to automatically send exposure events to the analytics solution you are using. The SDK builds a tracking code for your active analytics solution based on the experiments that the visitor has triggered in the last 5 seconds. For more information on how to implement this method, please refer to the following documentation.

note

To benefit from this feature, you will need to implement both the Python SDK and our Kameleoon JavaScript tag. We recommend you implement the Kameleoon Asynchronous tag, which you can install before your closing <body> tag in your HTML page, as it will be only used for tracking purposes.

Arguments

Name	Type	Description
visitor_code	str	The user's unique identifier. This field is mandatory.

Return value

Type	Description
str	JavaScript code to be inserted in your page

on_update_configuration

kameleoon_client.on_update_configuration(
    // configuration was updated
)

The on_update_configuration() method allows you to handle the event when configuration has updated data. It takes one input parameter: callable handler. The handler that will be called when the configuration is updated using a real-time configuration event.

Arguments

Name	Type	Description
handler	Callable[[], None]	The handler that will be called when the configuration is updated using a real-time configuration event.

set_legal_consent

### if you use KameleoonWSGIMiddleware service
visitor_code = kameleoon_client.get_visitor_code(cookies_readonly=request.COOKIES)
kameleoon_client.set_legal_consent(visitor_code, True)

### if you want to manage cookies manually
cookies = http.cookies.SimpleCookie()
cookies.load(cookie_header)

visitor_code = kameleoon_client.get_visitor_code(cookies=cookies)
kameleoon_client.set_legal_consent(visitor_code, True, cookies)

cookie_header = cookies.output()

You must use this method to specify whether the visitor has given legal consent to use personal data. Setting the consent parameter to False limits the types of data that you can include in tracking requests. This helps you adhere to legal and regulatory requirements while responsibly managing visitor data. You can find more information on personal data in the Consent management policy.

Arguments

Name	Type	Description
visitor_code	str	The user's unique identifier. This field is required.
consent	bool	A boolean value representing the legal consent status. `true` indicates the visitor has given legal consent, `false` indicates the visitor has never provided, or has withdrawn, legal consent. This field is required.
cookies	Optional[Dict[str, http.cookies.Morsel[str]]]	The cookies to be adjusted based on the legal consent status, as `Dict[str, http.cookies.Morsel[str]]` or `http.cookies.SimpleCookie[str]` object. This field is optional.

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

Data

Browser

kameleoon_client.add_data(visitor_code, Browser(BrowserType.CHROME))

kameleoon_client.add_data(visitor_code, Browser(BrowserType.SAFARI, 10))

Name	Type	Description
browser	BrowserType	List of browsers: CHROME, INTERNET_EXPLORER, FIREFOX, SAFARI, OPERA, OTHER. This field is mandatory.
version	float	Version of browser. This field is optional.

PageView

kameleoon_client.add_data(visitor_code, PageView("https://url.com", "title", [3]))

Name	Type	Description
url	String	URL of the page viewed. This field is mandatory.
title	String	Title of the page viewed. This field is mandatory.
referrers	Optional[List[int]]	Referrers of viewed pages. This field is optional.

note

The index (ID) of the referrer is available on our Back-Office, in the Acquisition channel configuration page. Be careful: this index starts at 0, so the first acquisition channel you create for a given site would have the ID 0, not 1.
https://help.kameleoon.com/create-acquisition-channel

Conversion

kameleoon_client.add_data(visitor_code, Conversion(32, 10, false))

Name	Type	Description
goal_id	Integer	ID of the goal. This field is mandatory.
revenue	Float	Conversion revenue. This field is optional.
negative	Boolean	Defines if the revenue is positive or negative. This field is optional.

CustomData

kameleoon_client.add_data(visitor_code, CustomData(1, "some custom value"))

kameleoon_client.add_data(visitor_code, CustomData(1, "first value", "second value"))

Name	Type	Description
id	int	Index / ID of the custom data to be stored. This field is mandatory.
*args	str	Values of the custom data to be stored. This field is mandatory.

note

The index (ID) of the custom data is available on our Back-Office, in the Custom data configuration page. Be careful: this index starts at 0, so the first custom data you create for a given site will have the ID 0, not 1.

Device

kameleoon_client.add_data(visitor_code, Device(DeviceType.DESKTOP))

Name	Type	Description
device	DeviceType	List of devices: `PHONE`, `TABLET`, `DESKTOP`. This field is mandatory.

UserAgent

kameleoon_client.add_data(visitor_code, UserAgent('TestUserAgent'))

Name	Type	Description
value	str	The User-Agent value that will be sent with tracking requests. This field is mandatory.

Store information on the user-agent of the visitor. Server-side experiments are more vulnerable to bot traffic than client-side experiments. To address this, Kameleoon uses the IAB/ABC International Spiders and Bots List to identify known bots and spiders. Kameleoon also uses the UserAgent field to filter out bots and other unwanted traffic that could otherwise skew your conversion metrics. For more details, see the help article on Bot filtering.

If you use internal bots, we suggest that you pass the value curl/8.0 of the userAgent to exclude them from our analytics.

Targeting conditions

The Kameleoon SDKs support a variety of predefined targeting conditions that you can use to target users in your campaigns. For the list of conditions supported by this SDK, see Use visit history to target users.

You can also use your own external data to target users.

Python SDK

Getting started​

Installing the SDK​

Installing the Python client​

Additional configuration​

Initializing the Kameleoon client​

Using the Kameleoon Python SDK in a Django environment​

Technical considerations​

Overview​

Polling​

Streaming​

Reference​

KameleoonClientFactory​

create​

Arguments​

Exceptions thrown​

forget​

Arguments​

KameleoonClient​

wait_init_async​

Return value​

wait_init​

Return value​

get_visitor_code​

Arguments​

Return value​

Exceptions thrown​

is_feature_active​

Arguments​

Return value​

Exceptions thrown​

get_feature_variation_key​

Arguments​

Return value​

Exceptions thrown​

get_feature_variable​

Arguments​

Return value​

Exceptions thrown​

get_feature_variation_variables​

Arguments​

Return value​

Exceptions thrown​

track_conversion​

Arguments​

add_data​

Arguments​

flush​

Arguments​

get_feature_list​

Return value​

get_active_feature_list_for_visitor​

Arguments​

Return value​

get_remote_data​

Arguments​

Return value​

get_remote_data_async​

Arguments​

Return value​

get_remote_visitor_data​

Arguments​

Return value​

get_remote_visitor_data_async​

Arguments​

Return value​

get_visitor_warehouse_audience​

Arguments​

Return value​

Exceptions thrown​

get_visitor_warehouse_audience_async​

Arguments​

Return value​

Exceptions thrown​

get_engine_tracking_code​

Arguments​

Return value​

on_update_configuration​

Arguments​

set_legal_consent​

Getting started

Installing the SDK

Installing the Python client

Additional configuration

Initializing the Kameleoon client

Using the Kameleoon Python SDK in a Django environment

Technical considerations

Overview

Polling

Streaming

Reference

KameleoonClientFactory

create

Arguments

Exceptions thrown

forget

Arguments

KameleoonClient

wait_init_async

Return value

wait_init

Return value

get_visitor_code

Arguments

Return value

Exceptions thrown

is_feature_active

Arguments

Return value

Exceptions thrown

get_feature_variation_key

Arguments

Return value

Exceptions thrown

get_feature_variable

Arguments

Return value

Exceptions thrown

get_feature_variation_variables

Arguments

Return value

Exceptions thrown

track_conversion

Arguments

add_data

Arguments

flush

Arguments

get_feature_list

Return value

get_active_feature_list_for_visitor

Arguments

Return value

get_remote_data

Arguments

Return value

get_remote_data_async

Arguments

Return value

get_remote_visitor_data

Arguments

Return value

get_remote_visitor_data_async

Arguments

Return value

get_visitor_warehouse_audience

Arguments

Return value

Exceptions thrown

get_visitor_warehouse_audience_async

Arguments

Return value

Exceptions thrown

get_engine_tracking_code

Arguments

Return value

on_update_configuration

Arguments

set_legal_consent

Arguments