Skip to content
This repository has been archived by the owner on Sep 2, 2021. It is now read-only.

Requirements

Jump to bottom
Gareth Coles edited this page Oct 16, 2013 · 26 revisions

For help with installing these, see the section below the lists.

Please note that we ARE working on a setup script to make this easier. For now, please follow the OS-specific instructions below.

Python

  • Python, version 2.6 or higher (We recommend version 2.7)
  • Read and write access to the filesystem

Required modules

  • Twisted | Pip: twisted
  • Zope.Interface (Unless you're on Windows - see below) | Pip: zope.interface
  • yapsy (The plugin interface library) | Pip: yapsy

Optional dependencies

Linux

Installation on Linux is a piece of cake, relatively speaking. Simply use your package manager to install the packages you need. Most distros will prefer Python 2.6 or 2.7 if you install the python package, and packages such as python-twisted or python-yapsy usually exist. If not, install pip and follow the Windows instructions for installing modules below, but also use pip to install Twisted. If you're using SSL, you'll also need to install the OpenSSL package for your distro of Linux.

See the documentation for your distro of Linux for more information on how to use the package manager.

Windows

As we do develop on Windows, we find the following method to be the simplest way to install everything required.

  • Install Python for Windows. Do not install the 64-bit package, only install the 32-bit one.
  • Add Python and its scripts to your PATH (see here).
  • Install setuptools. Open a command prompt and run easy_install pip to install pip. On Linux, these usually come pre-installed with Python, but that is often not the case on Windows.
  • Use the Twisted installer to install Twisted. You do not need to install Zope.Interface.
  • In a command prompt, use pip to install all the other modules you need; pip install <module> - See above for the pip module names.
  • If you need SSL support, install OpenSSL for Windows from this link.

Mac OSX

  • First of all, install Homebrew if you haven't already.
  • Open the terminal and run brew install python. This will also install pip.
  • Install all the modules you need to use with pip.
  • OSX ships with an outdated version of OpenSSL. While it should be sufficient, you can see here for instructions on updating it.

Previous (Introduction) | Home | Next (Setting up)

Clone this wiki locally