Skip to content

optimizely/python-sdk

Repository files navigation

#Optimizely Python SDK Build Status Coverage Status Apache 2.0

This repository houses the Python SDK for Optimizely's server-side testing product, which is currently in private beta.

##Getting Started

###Installing the SDK

The SDK is available through PyPi. To install:

pip install optimizely-sdk

###Using the SDK See the Optimizely server-side testing developer documentation to learn how to set up your first custom project and use the SDK. Please note that you must be a member of the private server-side testing beta to create custom projects and use this 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.