doc/installation.rst

   1 Installation
   2 ============
   3
   4 Prerequisites
   5 ^^^^^^^^^^^^^
   6
   7 This package requires django 1.2. It is not tested on earlier versions and may
   8 not work properly there.
   9
  10 To build the documentation from source you will need sphinx.
  11
  12 Installation Options
  13 ^^^^^^^^^^^^^^^^^^^^
  14
  15 There are several installation options available:
  16
  17 Using Ubuntu PPAs
  18 -----------------
  19
  20 For Ubuntu 10.04 onward there is a stable PPA (personal package archive):
  21
  22 * ppa:linaro-validation/ppa
  23
  24 To add a ppa to an Ubuntu system use the add-apt-repository command::
  25
  26     sudo add-apt-repository ppa:linaro-validation/ppa
  27
  28 After you add the PPA you need to update your package cache::
  29
  30     sudo apt-get update
  31
  32 Finally you can install the package, it is called `python-versiontools`::
  33
  34     sudo apt-get install python-linaro-django-pagination
  35
  36
  37 Using Python Package Index
  38 --------------------------
  39
  40 This package is being actively maintained and published in the `Python Package
  41 Index <http://http://pypi.python.org>`_. You can install it if you have `pip
  42 <http://pip.openplans.org/>`_ tool using just one line::
  43
  44     pip install linaro-django-pagination
  45
  46
  47 Using source tarball
  48 --------------------
  49
  50 To install from source you must first obtain a source tarball from either pypi
  51 or from `Launchpad <http://launchpad.net/>`_. To install the package unpack the
  52 tarball and run::
  53
  54     python setup.py install
  55
  56 You can pass ``--user`` if you prefer to do a local (non system-wide) installation.
  57
  58 ..  note::
  59
  60     To install from source you will need distutils (replacement of setuptools)
  61     They are typically installed on any Linux system with python but on Windows
  62     you may need to install that separately.