-
Notifications
You must be signed in to change notification settings - Fork 7
Requirements
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, version 2.6 or 2.7 (We recommend version 2.7), but NOT Python 3.
- If you're on Mac, DO NOT INSTALL FROM THE SITE. See the Mac section below.
- Read and write access to the filesystem
-
Twisted | Pip:
pip install twisted -
Zope.Interface (Unless you're on Windows - see below) | Pip:
pip install zope.interface -
Kitchen (Everything but the kitchen sink) | Pip:
pip install kitchen -
yapsy (The plugin interface library) | Pip:
pip install yapsy==1.10.2-pythons2n3- Make sure you install it like this! -
PyYAML (For config and data) | pip:
pip install pyyaml
-
PyOpenSSL (For any protocols that use SSL) | Pip:
pip install pyopenssl -
Google's Protocol Buffers (protobuf) library (For the Mumble protocol) | Pip:
pip install protobuf - BeautifulSoup 4 (For the URLs plugin) | Pip:
pip install beautifulsoup4 - Netaddr module (For the URLs plugin) | Pip:
pip install netaddr
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. Your package manager will probably include versions of the above modules as well, but we highly recommend not using these as they're usually very outdated (especially in the case of yapsy, which has an inconsistent update policy). Instead, install pip and use pip install <module> to install each one. You can find the module names in the lists above. 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.
As we do develop on Windows, we find the following method to be the simplest way to install everything required.
- Install Python 2.7.6 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 (Pick the win32 download for Python 2.7). Open a command prompt and run
easy_install pipto 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. Don't forget to install Zope.Interface!
- If you need SSL support, install OpenSSL for Windows from here and PyOpenSSL from here.
- In a command prompt, use pip to install all the other modules you need;
pip install <module>- See above for the pip module names.
- 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.