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 Other extras
  34 ============
  35
  36 ``pip install m_librarian[web]`` installs libraries needed for web-ui.
  37
  38 ``pip install m_librarian[wx]`` installs a library needed for wx GUI
  39 (``wxPython``).
  40
  41 Installation from sources
  42 =========================
  43
  44 To install the library from sources system-wide run run the following
  45 command:
  46
  47 ::
  48
  49     sudo python setup.py install
  50
  51 If you don't want to install it system-wide you can install it in your
  52 home directory; run run the following command:
  53
  54 ::
  55
  56     python setup.py install --user
  57
  58 Option '--user' installs m_librarian into
  59 $HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
  60 automatically. It also installs m_librarian scripts into $HOME/.local/bin;
  61 add the directory to your $PATH or move the scripts to a directory in your
  62 $PATH.