kangkona / python-sdk

Optimizely Python SDK

This repository houses the Python SDK for Optimizely Full Stack.

Getting Started

Installing the SDK

The SDK is available through PyPi. To install:

pip install optimizely-sdk

Using the SDK

See the Optimizely Full Stack developer documentation to learn how to set up your first Python project and use the SDK.

Development

Building the SDK

Build the SDK using the following command:

python setup.py sdist

This will create a tarball under dist/

You can then install the SDK and its dependencies with:

pip install dist/optimizely-sdk-{VERSION}.tar.gz

Unit tests

Running all tests

You can run all unit tests with:

nosetests

Running all tests in a file

To run all tests under a particular test file you can use the following command:

nosetests tests.<file_name_without_extension>

For example, to run all tests under test_event, the command would be:

nosetests tests.test_event

Running all tests under a class

To run all tests under a particular class of tests you can use the following command:

nosetests tests.<file_name_without_extension>:ClassName

For example, to run all tests under test_event.EventTest, the command would be:

nosetests tests.test_event:EventTest

Running a single test

To run a single test you can use the following command:

nosetests tests.<file_name_without_extension>:ClassName.test_name

For example, to run test_event.EventTest.test_dispatch, the command would be:

nosetests tests.test_event:EventTest.test_dispatch

Contributing

Please see CONTRIBUTING.