aboutsummaryrefslogtreecommitdiff
path: root/doc/installation.rst
blob: 3b30cb473a93a71d309c8f9ada526dbceb949731 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

.. _installation:

Installation
============

Prerequisites
^^^^^^^^^^^^^

The following debian packages are needed to use LAVA Test:

* python-setuptools
* python-apt
* usbutils
* python-testrepository - for running unit tests
* python-sphinx - for building documentation

Installation Options
^^^^^^^^^^^^^^^^^^^^

There are several installation options available:

Using Python Package Index
--------------------------

This package is being actively maintained and published in the `Python Package
Index <http://http://pypi.python.org>`_. You can install it if you have `pip
<http://pip.openplans.org/>`_ tool using just one line::

    pip install lava-android-test


Using source tarball
--------------------

To install from source you must first obtain a source tarball from either pypi
or from `Launchpad <http://launchpad.net/>`_. To install the package unpack the
tarball and run::

    python setup.py install

You can pass ``--user`` if you prefer to do a local (non system-wide)
installation. Note that executable programs are placed in ``~/.local/bin/`` and
this directory is not on ``PATH`` by default.

Installing for development
--------------------------

An easy way to set things up for local development is to create a python
virtualenv. You can create the virtualenv anyway in your filesystem. In
the example below, its simply put under the bzr repo where development
is being done from::

    bzr branch lp:lava-android-test
    cd lava-android-test
    virtualenv .venv ; . ./venv/bin/activate
    pip install keyring
    ./setup.py develop