This part of the documentation covers the installation of goodplay.

Installing Docker

goodplay makes use of isolated containerized environments provided by Docker for running your tests.


If you only require your tests to be run on localhost or some other test environment you manage on your own, you can skip Docker installation and continue with the next section.

As goodplay uses Docker Compose which enables you to use some great Docker features like user-defined networks or embedded DNS server, we recommend to run at least Docker version 1.10.0. There are a lot of options when it comes to setting up a Docker host.

When running a Linux distribution with a recent kernel version, docker is most likely supported natively. In this case the installation process will finish in a minute.

When running on Mac OS X, docker is not natively supported (yet). Fortunately there is docker-machine available which lets you create Docker hosts as virtual machine on your computer, on cloud providers, or inside your own data center. In this case Docker Toolbox helps you to setup everything you need.

Please make sure to read the official Install Docker Engine guide.

Installing goodplay

Installing latest released goodplay version is simple with pip, just run this in your terminal:

$ pip install goodplay

Alternatively you can install the latest goodplay development version:

$ pip install git+

Get the Code

goodplay is actively developed on GitHub, where the code is always available.

You can either clone the public repository:

$ git clone

Download the tarball:

$ curl -OL

Or, download the zipball:

$ curl -OL

Once you have a copy of the source, you can install it into your site-packages easily:

$ python install