
Table of contents:

  1. Software requirements
  2. Install manually
  3. Install on Debian
  4. Install on Gentoo
  5. Install on Windows
  6. Run the unit tests
  7. Checkout from the Git repository


1. Software requirements
========================

Software    Version  Used by          Home
----------  -------  ---------------  ----------------------------------------
Python        2.6.4  itools           http://www.python.org/
pkg-config     0.23  itools           http://pkg-config.freedesktop.org/
pytz                 itools.core      http://pytz.sourceforge.net/
glib           2.20  itools.fs        http://www.gtk.org/
pygobject      2.20  itools.fs        http://www.pygtk.org/
Git             1.7  itools.git       http://git-scm.com/
libsoup        2.28  itools.http      http://live.gnome.org/LibSoup
reportlab       2.3  itools.pdf       http://www.reportlab.org/
xapian        1.0.8  itools.xapian    http://www.xapian.org/
pywin32         212  (Windows)        http://sf.net/projects/pywin32/
matplotlib     0.91  ipkg-quality.py  http://matplotlib.sourceforge.net/
gettext        0.17  ipkg-build.py    http://www.gnu.org/software/gettext/
sphinx               ipkg-doc.py      http://pypi.python.org/pypi/Sphinx

To be able to handle some file formats you need:

Software    Version  Format           Home
----------  -------  ---------------  ----------------------------------------
PIL           1.1.6  PNG, JPG, etc.   http://www.pythonware.com/products/pil/
rsvg           2.30  SVG              http://www.pygtk.org/
xlrd          0.6.1  XLS              http://www.lexicon.net/sjmachin/xlrd.htm
poppler      0.10.4  PDF              http://poppler.freedesktop.org/
wv2           0.2.3  DOC              https://sourceforge.net/projects/wvware


2. Install manually
========================

First download the package (replace XX and Y by the desired major and minor
version numbers):

  $ wget http://download.hforge.org/0.XX/itools-0.XX.Y.tar.gz

Now unpack the source:

  $ tar xzf itools-0.XX.Y.tar.gz

Change the working directory this way:

  $ cd itools-0.XX.Y

And finally install itools with distutils:

  $ python setup.py install


3. Install on Debian
========================

All the software required by itools is available in Debian Stable (squeeze).
Install these packages:

  # apt-get install gettext git python-gobject-dev python-tz
  # apt-get install libsoup2.4-dev python-xapian
  # apt-get install python-imaging python-rsvg
  # apt-get install g++ libpoppler-dev libwv2-dev python-xlrd
  # apt-get install python-reportlab

And finally install the itools package by hand (see Section 2).


4. Install on Gentoo
========================

If you use Gentoo you are lucky.  Since itools is available in the hforge
overlay, start by installing this overlay, to do so:

1. Edit the /etc/layman/layman.cfg file and add the hforge overlay list, so
   the 'overlays' variable looks this way:

  overlays  : http://www.gentoo.org/proj/en/overlays/repositories.xml
              http://overlay.hforge.org/list.xml

2. Add the hforge overlay:

  # layman -a hforge-overlay

Then unmask the itools package and emerge:

  # echo "dev-python/itools ~amd64" >> /etc/portage/package.keywords
  # layman -S
  # emerge itools


5. Install on Windows
========================

Today itools is not available on the Windows platform because of a bug in
one of the required software, pygobject:

  http://bugzilla.gnome.org/show_bug.cgi?id=562790

Note: you will find packages like pkg-config and glib compiled for Windows
on http://ftp.gnome.org/pub/gnome/binaries/win32/ (don't forget to check
the "dependencies" directory).


6. Run the unit tests
========================

To run the unit tests first you must download and unpack the source as
described in Section 2.

Then change to the test directory and run the tests:

  $ cd itools-0.XX.Y/test
  $ python test.py

If there are errors, please report either to the issue tracker or to the
mailing list:

  - http://bugs.hforge.org/
  - http://www.hforge.org/community


7. Checkout from the Git repository
===================================

If you desire to install the latest and hottest revision of itools, you need
to clone the Git repository this way:

  $ git clone git://git.hforge.org/itools.git
  $ cd itools

Then checkout the latest stable branch:

  $ git checkout -b 0.XX origin/0.XX

Then installing itools properly is a three steps process:

  $ python setup.py install   # This makes the ipkg-build.py script available
  $ ipkg-build.py             # This compiles the MO files, etc.
  $ python setup.py install   # This re-installs itools with everything in
