project_template/docs/install.rst

   1 Installation using pip
   2 ======================
   3
   4 System-wide
   5 -----------
   6
   7 ::
   8
   9     sudo pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' {project}
  10
  11 User mode
  12 ---------
  13
  14 ::
  15
  16     pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' --user {project}
  17
  18 For Python 2.6 the command is easy_install.
  19
  20 Installation from sources
  21 =========================
  22
  23 To install the library from sources system-wide run run the following
  24 command:
  25
  26 ::
  27
  28     sudo python setup.py install -O2
  29
  30 If you don't want to install it system-wide you can install it in your
  31 home directory; run run the following command:
  32
  33 ::
  34
  35     python setup.py install -O2 --user
  36
  37 Option '--user' installs {project} into
  38 $HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
  39 automatically. It also installs {project} scripts into $HOME/.local/bin;
  40 add the directory to your $PATH or move the scripts to a directory in your
  41 $PATH.