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``). Should work for non-Linux platforms, but for Linux
  40 ``wxPython`` should be installed separately either using system package
  41 manager, or from https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ ,
  42 or using ``conda``::
  43
  44     conda create -n wx27 python=2.7 wxpython
  45     conda activate wx27
  46
  47 Python 2.7 is used here just an example, the librarin works with any
  48 Python version, 2.7 and 3.4+.
  49
  50 Installation from sources
  51 =========================
  52
  53 To install the library from sources system-wide run run the following
  54 command:
  55
  56 ::
  57
  58     sudo python setup.py install
  59
  60 If you don't want to install it system-wide you can install it in your
  61 home directory; run run the following command:
  62
  63 ::
  64
  65     python setup.py install --user
  66
  67 Option '--user' installs m_librarian into
  68 $HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
  69 automatically. It also installs m_librarian scripts into $HOME/.local/bin;
  70 add the directory to your $PATH or move the scripts to a directory in your
  71 $PATH.