=================
FunkLoad_ INSTALL
=================

:author: Benoit Delbosc

:address: bdelbosc _at_ nuxeo.com

:revision: $Id$

:abstract: This document describes how to install the FunkLoad_ tool.

.. sectnum::    :depth: 1

.. contents:: Table of Contents


Required packages
-----------------

* libexpat1
* works fine with python 2.3.5, looks like ok with python 2.4
* python distutils, on a Debian system::

    sudo apt-get install python-dev

* python xml, for example on a Debian system::

    sudo apt-get install python-xml

* For FunkLoad_ > 1.1.0 you need to use EasyInstall_, download ez_setup.py_,
  and run it::

    cd /tmp
    wget http://peak.telecommunity.com/dist/ez_setup.py
    sudo python ez_setup.py

  This will download and install the appropriate setuptools egg for your
  Python version.


Optional packages
-----------------

* To produce charts : python-gdchart (0.6.1-8 is fine), on Debian::

    apt-get install python-gdchart

* Starting with version 1.3.0 the recorder use TCPWatch_::

    cd /tmp
    wget http://hathawaymix.org/Software/TCPWatch/tcpwatch-1.3.tar.gz
    tar xzvf tcpwatch-1.3.tar.gz
    cd tcpwatch
    python setup.py build
    sudo python setup.py install


Installation
------------

Easy installation
~~~~~~~~~~~~~~~~~

Install the latest stable package::

  sudo easy_install -U funkload

This will install FunkLoad_, webunit_ and docutils_ eggs.


Latest snapshot version
~~~~~~~~~~~~~~~~~~~~~~~~

Install the latest development snapshot available::

  sudo easy_install -f http://funkload.nuxeo.org/snapshots/ funkload



Development version
~~~~~~~~~~~~~~~~~~~

If you want to try the latest unstable sources from svn ::

    svn co http://svn.nuxeo.org/pub/funkload/trunk /tmp/funkload
    cd /tmp/funkload/
    python setup.py build
    sudo python setup.py install



Test it
-------

Install the FunkLoad_ examples::

  fl-install-demo

Go to the demo/xmlrpc folder then::

  cd funkload-demo/xmlrpc/
  make test

To test benching and report building just::

  make bench

See ``funkload-demo/README.txt`` for others examples.



Problems ?
----------

* got a ::

    error: invalid Python installation: unable to open /usr/lib/python2.4/config/Makefile (No such file or directory)

  Install python2.4-dev package.

* easy_install complains about conflict, if FunkLoad_, webunit_ or docutils_
  were previously installed without using EasyInstall_.  You need to try
  with the ``--delete-conflicting`` option, see easy_install_ documentation.

* If you still have conflict try to remove FunkLoad_ from your system::

    easy_install -m funkload
    rm -rf /usr/lib/python2.3/site-packages/funkload*
    rm -rf /usr/local/funkload/
    rm /usr/local/bin/fl-*
    rm /usr/bin/fl-*

  then reinstall

* When testing ``make test`` return ::

    ### credentialctl: Stopping credential server.
    python: can't open file '/usr/lib/python2.4/site-packages/funkload-1.2.0-py2.4.egg/funkload/credentialctl.py': [Errno 20] Not a directory

  Starting with FunkLoad_ 1.2.0 scripts are installed in /usr/bin, previously
  they were in /usr/local/bin, you need to remove them::

    sudo rm /usr/local/bin/fl-*

* No charts on your report. You need to have gdchart python module check
  ``import gdchart``. I am looking for hints on how to install gdchart on
  non Debian system.


--------------------------

See README.txt_ for more information about FunkLoad_.

See CHANGES.txt_ for information on FunkLoad_ packages.

See demo_ folder for other examples.


.. _FunkLoad: http://funkload.nuxeo.org/
.. _webunit: http://mechanicalcat.net/tech/webunit/
.. _README.txt: README.html
.. _CHANGES.txt: CHANGES.html
.. _demo: http://svn.nuxeo.org/trac/pub/browser/funkload/trunk/funkload/demo/
.. _EasyInstall: http://peak.telecommunity.com/DevCenter/EasyInstall
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall#command-line-options
.. _ez_setup.py: http://peak.telecommunity.com/dist/ez_setup.py
.. _docutils: http://docutils.sourceforge.net/
.. _TCPWatch: http://hathawaymix.org/Software/TCPWatch/