doc/installation.rst

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