In a previous blog post we covered how to install a Node.js client application. In this post we will cover installing a Python3/Django application to interact with the Blue Button 2.0 Sandbox API.


There are some pre-requisites needed to install and run this Blue Button Client (BBC) application on your local machine:

  • Python 3.4 or later (
  • The VirtualEnv utilities (
  • Git Command Line Utilities (

Download a version of Python3 for your platform from ([].

The VirtualEnv utilities enable you to isolate this installation from the standard version of Python installed on your machine.

BBC is maintained on Github. You will need the Git Command Line tools in order to download the code. It has been tested with Py4 and 3.5. If you use Python 3.5 you can use the “venv” command instead of the virtualenv utilities to create your virtual environment.

Your Developer Environment

These instructions are based on installing on a MacOS (10.13.4) laptop. The steps involved should be the same for Linux Workstations. Windows PC configuration, particularly for installing the pre-requisites, may vary.

These instructions assume that you are a developer that is comfortable working in a terminal/command line environment.

Create and Activate a Virtual Environment

Create the virtual environment to store libraries and modules needed by BBC:

mkdir ~/.virtualenv
python3 -m venv ~/.virtualenv/pd_bbc

Activate the environment with

source ~/.virtualenv/pd_bbc/bin/activate

Download the Blue Button 2.0 Client Code

mkdir -p ~/developer/pd_bbc
cd ~/developer/pd_bbc
git clone

Check out the file

There are detailed instructions for installing the client application in the file in the root directory of the project.

Install the Client Application Requirements

cd ~/developer/pd_bbc/bluebutton-sample-client-django
pip install bbc/requirements/requirements.txt

Get Your Sandbox Credentials

Anyone can register for an account in the Blue Button 2.0 Developer Sandbox. Go to and click on the “Sign up for the Developer Sandbox” link to create an account.

You will receive an email notification that your account has been created. Click on the link in the email to validate and activate your account. Then you can log in at

Once you log in to your Developer sandbox account you can create an application.
Click on “Application Registration” and register a new application.

Give your application a descriptive name. For example: “My Organization’s Claims Analyzer”

Set the Client Type and Authorization Grant fields as follows: Client Type: “Confidential” Authorization Grant: “Authorization Code”

The Redirect URIs field is where you can enter multiple URIs separated by a space or on a new line / carriage return / Enter key.

You will need the path to an endpoint where your application will be listening for a request from our API to provide you the results of an authorization request.

In the case of the application we are installing the callback path for the redirect_uri is:


The above redirect_uri setting is critically important. If this does not match the IP Address or domain name and path that your application is responding to you will get an “Error: invalid_request” after authorizing a user.

Copy the Client ID and Client Secret values. You will need these to setup your application. Fill out the other fields in the form and click “Save”.

Configure the Settings File

cd ~/developer/pd_bbc/bluebutton-sample-client-django/bbc
cp bbc/settings/ bbc/settings/
vi bbc/settings/

update the values for

Set the value for Client ID in the SOCIAL_AUTH_OAUTH2IO_KEY variable. Set the value for Client Secret in the SOCIAL_AUTH_OAUTH2IO_SECRET variable.

Save the file.

Setup the Client Application

python makemigrations --settings bbc.settings.local
python migrate --settings bbc.settings.local
python createsuperuser --settings bbc.settings.local

Enter the name and password for the superuse/admin account.

Run the Client Application

python runserver --settings bbc.settings.local --insecure

Connect to the Synthetic Data

Open a browser and goto:


Click the button to login to CMS. When prompted use one of the synthetic beneficiary user names and passwords and authorize access to your application.

Here is an example synthetic user account: BBUser10100 with password PW10100!.

You should now have a synthetic user account connected to your application and the app should be displaying a series of links for each type of resource. The screen should look something like this:

Sample Django Client App

If you have feedback on this post. Please drop us a message in the Google Developer Group for Blue Button 2.0 API.

Back to top Subscribe to RSS Feed Comments via Google Group