Installation Guide

Contents

• Installation Guide
  • Easy Installation
  • Manual Installation
    • Step 1
    • Step 2
  • Optional Extras
  • C-Extension
  • Advanced Options
  • Documentation

PyAMF requires Python 2.3 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 PyAMF:

easy_install pyamf

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 pyamf again. If you run into problems, try the manual installation instructions below.

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

easy_install -U pyamf

Manual Installation

To use PyAMF with Python 2.3 or 2.4, 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.

You don’t need these packages if you’re using Python 2.5 or newer.

• ElementTree 1.2.6 or newer
• uuid 1.30 or newer

Step 1

Download and unpack the PyAMF archive of your choice:

tar zxfv PyAMF-<version>.tar.gz
cd PyAMF-<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.

To disable the installation of the C-extension, supply the --disable-ext option:

python setup.py install --disable-ext

You can run the unit tests like this:

python setup.py test

Optional Extras

PyAMF integrates with the following optional third-party Python libraries:

• wsgiref 0.1.2 or newer (included in Python 2.5 and newer)
• SQLAlchemy 0.4 or newer
• Twisted 2.5 or newer
• Django 0.97 or newer
• Google App Engine 1.0 or newer

C-Extension

To modify the cPyAMF extension you need:

• Cython 0.10 or newer

And run the command below on the .pyx files to create the .c file, which contains the C source for the cPyAMF extension module:

cython amf3.pyx

Advanced Options

Because of setuptools you can do, with the release tag, as well as with trunk:

easy_install http://svn.pyamf.org/tags/release-0.5.1

To find out about other advanced installation options, run:

easy_install --help

Also see Installing Python Modules for detailed information.

To install PyAMF to a custom location:

easy_install --prefix=/path/to/installdir

Documentation

To build the documentation you need:

• Sphinx 0.6.3 or newer
• a copy of the PyAMF source distribution

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

make html

Windows users can run the make.bat file instead:

make.bat

This will generate the HTML documentation in the pyamf/doc/_build/html folder. This documentation is identical to the content on the main PyAMF website.

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

sphinx-build -b html . _build