- Documentation

Python SDK

This section describes how to set up and install the Python SDK and how to deploy a feature flag.

Getting started with Python SDK

Step 1 - Setting up

The following are prerequisites for installing the Python SDK:

  1. A Rollout account. See Signup Page to create an account.

  2. An Application created in the Rollout dashboard.

    • The first time you log into your account, click the Create New App button to create a new app.
  1. An environment key.
    • Get the key from App Settings > Environment > Key

Step 2 - Installing the Python SDK

Add the CloudBees Rollout Python package to your application

$ pip install rox

Add the following lines of code to your application

# Import Rollout SDK
from rox.server.rox_server import Rox
from rox.server.flags.rox_flag import RoxFlag
from rox.server.flags.rox_variant import RoxVariant

# Create Roxflags in the Flags container class
class Flags:
    def __init__(self):
        #Define the feature flags
        self.enableTutorial = RoxFlag(False)
        self.titleColors = RoxVariant('White', ['White', 'Blue', 'Green', 'Yellow'])

flags = Flags()

# Register the flags container with Rollout
Rox.register("", flags)

# Setup the Rollout environment key
cancel_event = Rox.setup("<ROLLOUT-ENV-KEY>").result();

# Boolean flag example
print('enableTutorial is %s' % flags.enableTutorial.is_enabled())

# Multivariate flag example
print('color is %s' % flags.titleColors.get_value())

Container class registration and environment key setup

  • You can not call Rox.setup() twice in the same runtime.

Run your application

Running the application

The Flag name is automatically added to the Rollout dashboard after running the application.

Step 3 - Deploying a feature flag

Finding your flags in the Rollout dashboard

After creating feature flags and running your feature code, you can find your flags in the Rollout dashboard.

To find your flags in the Rollout dashboard:

  1. Find your app in the Rollout dashboard
    To switch between apps, click on the app name in the top-left corner of the screen and select the app you want from the pulldown.

  2. Click on Flags on the left side of the navigation panel.

  3. Confirm that your flag is listed in the flag view.

Configuring deployment rules

  1. Go to Rollout's dashboard.
  2. Click on Experiments on the left panel.
  3. Click the Create Experiment button to create a new experiment.
  4. In the New Experiment window:
    • Find the Flag name from the menu, choose it.
    • Click the Set Audience button to continue. The Experiment Details view appears.
  5. Select either True, False, Split or Scheduled. Split allows you to select the percentage of the target group that you want to deploy. Scheduled allows you to schedule a deployment date.
  1. Click Update Audience.


  • You can not delete the default condition.
  • You can click the Reset link to go back to the state from before you started making changes. Reset only appears when you've made saved modifications.

See Audience for more detailed information.

Updated about a month ago

Python SDK

This section describes how to set up and install the Python SDK and how to deploy a feature flag.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.