Installation Guide¶
Mini-AMF requires Python 2.7 or 3.4+, and DefusedXML.
Manual Installation¶
First install DefusedXML. If you wish to build the C accelerator module, you will also need a C compiler and the libraries for compiling Python extensions.
Download and unpack the Mini-AMF archive of your choice:
tar zxfv Mini-AMF-<version>.tar.gz
cd Mini-AMF-<version>
Then install using the setup.py script:
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¶
Unit tests can also be run via setup.py. No additional modules
are required:
python setup.py test
C Accelerator Module¶
The C accelerator module is broken, and will not be compiled or
installed by default. If you want to experiment with it, supply
the --with-accel option:
python setup.py --with-accel test
You will need Cython to build the module, and do not be surprised when the test runner crashes.
Documentation¶
To build the documentation you need Sphinx. The official documentation is generated with Sphinx 1.5 running under Python 3.5. Older versions of Sphinx and/or Python may also work.
From the doc subdirectory of the source distribution, run this
command:
sphinx-build -b html . _build
This will generate HTML documentation in the doc/_build
folder.