docs/install.rst

   1 Installation using pip
   2 ======================
   3
   4 System-wide
   5 -----------
   6
   7 ::
   8
   9     sudo pip install m_librarian
  10
  11 User mode
  12 ---------
  13
  14 ::
  15
  16     pip install --user m_librarian
  17
  18 Virtual envs
  19 ------------
  20
  21 ::
  22
  23     pip install m_librarian
  24
  25 Progress bar
  26 ============
  27
  28 To allow ``ml-import.py`` to display progress bar the program requires
  29 library ``m_lib``. You can install the library separately using, e.g.,
  30 command ``pip install m_lib``. Or you can install the library with
  31 ``m_librarian``: ``pip install m_librarian[pbar]``.
  32
  33 Installation from sources
  34 =========================
  35
  36 To install the library from sources system-wide run run the following
  37 command:
  38
  39 ::
  40
  41     sudo python setup.py install
  42
  43 If you don't want to install it system-wide you can install it in your
  44 home directory; run run the following command:
  45
  46 ::
  47
  48     python setup.py install --user
  49
  50 Option '--user' installs m_librarian into
  51 $HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
  52 automatically. It also installs m_librarian scripts into $HOME/.local/bin;
  53 add the directory to your $PATH or move the scripts to a directory in your
  54 $PATH.