[[PageOutline(2-5, Table of Contents, floated)]]

= Installation guide =

== Dependencies ==

Py4bot is entirely written in python, and uses some third-party modules:

 * [https://pypi.python.org/pypi/evdev evdev], for usb devices handling
 * [http://www.numpy.org numpy], for matrix and other maths

'''evdev''' will be automatically installed with '''Py4bot''', as it is not yet in debian stable.

For '''numpy''', install it from debian with:

{{{
$ sudo apt install python-numpy
}}}

If you can't find the package in your distro, install it from source:

{{{
$ [sudo] pip install numpy
}}}

== Build source archive ==

If you downloaded '''Py4bot''' Git version, use the following command at '''Py4bot''' root:

{{{
$ python setup.py sdist
}}}

The archive will be build in the {{{dist/}}} directory.

== Install source archive ==

Once you have a source archive, either build from Git or downloaded from stable version, install the framework with:

{{{
$ pip install <path to>/Py4bot-<version>.tar.gz
}}}

(you may need to add the {{{--system}}} option on debian systems to install '''Py4bot''' in {{{/usr/local/}}} dir).

To update the Git version, use, at '''Py4bot''' root:

{{{
$ git pull
}}}

Then, re-build the source archive, as described above.

Finally:

{{{
$ pip uninstall Py4bot
$ pip install <path to>/Py4bot-<version>.tar.gz
}}}