Installation Guide

Contents

• Installation Guide
  • Easy Installation
  • Manual Installation
    • Prerequisites
    • Step 1
    • Step 2
  • Unit Tests
  • Advanced Options
  • Documentation
    • Sphinx
    • Epydoc

RTMPy requires Python 2.4 or newer. Python 3.0 isn’t supported yet.

Easy Installation

If you have setuptools or the easy_install tool already installed, simply type the following on the command-line to install RTMPy:

easy_install rtmpy

Note: you might need root permissions or equivalent for these steps.

If you don’t have setuptools or easy_install, first download ez_setup.py and run:

python ez_setup.py

After easy_install is installed, run easy_install rtmpy again. If you run into problems, try the manual installation instructions below.

To upgrade your existing RTMPy installation to the latest version use:

easy_install -U rtmpy

Manual Installation

Prerequisites

The following software packages are prerequisites:

• Twisted 2.5 or newer
• PyAMF 0.6b2 or newer
• zope.interface 3.3.0 or newer
• PyWin32 b210 or newer (for Windows only)

Step 1

Download and unpack the RTMPy archive of your choice:

tar zxfv RTMPy-<version>.tar.gz
cd RTMPy-<version>

Step 2

Run the Python-typical setup at the top of the source directory from a command-prompt:

python setup.py install

This will byte-compile the Python source code and install it in the site-packages directory of your Python installation.

Unit Tests

To run the RTMPy unit tests the following software packages must be installed. The easy_install command will automatically install them for you, as described above, but you can also choose to download and install the packages manually.

• unittest2 (included in Python 2.7 and newer)

You can run the unit tests using setuptools like this:

python setup.py test

Other libraries for unit testing are also supported, including:

• nose
• Trial

Advanced Options

To find out about other advanced installation options, run:

easy_install --help

Also see Installing Python Modules for detailed information.

To install RTMPy to a custom location:

easy_install --prefix=/path/to/installdir

Documentation

Sphinx

To build the Sphinx documentation you need:

• Sphinx 1.0 or newer
• sphinxcontrib.epydoc 0.4 or newer
• a copy of the RTMPy source distribution

Unix users run the command below in the rtmpy/doc directory to create the HTML version of the RTMPy documentation:

make html

Windows users can run the make.bat file instead:

make.bat

This will generate the HTML documentation in the rtmpy/doc/build/html folder. This documentation is identical to the content on the main RTMPy website.

Note: if you don’t have the make tool installed then you can invoke Sphinx from the rtmpy/doc directory directly like this:

sphinx-build -b html . build

Epydoc

To build the Epydoc API documentation you need:

• Epydoc 3.0 or newer
• a copy of the RTMPy source distribution

Run the command below in the root rtmpy directory to create the HTML version of the RTMPy API documentation:

epydoc --config=setup.cfg

This will generate the HTML documentation in the rtmpy/doc/build/api folder.