]> git.phdru.name Git - m_librarian.git/blob - docs/install.rst
Docs: Remove -O2 from installation instructions
[m_librarian.git] / docs / install.rst
1 Installation using pip
2 ======================
3
4 System-wide
5 -----------
6
7 ::
8
9     sudo pip install --trusted-host phdru.name --find-links=http://phdru.name/Software/Python/ m_librarian
10
11 User mode
12 ---------
13
14 ::
15
16     pip install --trusted-host phdru.name --find-links=http://phdru.name/Software/Python/ --user m_librarian
17
18 Virtual envs
19 ------------
20
21 ::
22
23     pip install --trusted-host phdru.name --find-links=http://phdru.name/Software/Python/ m_librarian
24
25 Installation from sources
26 =========================
27
28 To install the library from sources system-wide run run the following
29 command:
30
31 ::
32
33     sudo python setup.py install
34
35 If you don't want to install it system-wide you can install it in your
36 home directory; run run the following command:
37
38 ::
39
40     python setup.py install --user
41
42 Option '--user' installs m_librarian into
43 $HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
44 automatically. It also installs m_librarian scripts into $HOME/.local/bin;
45 add the directory to your $PATH or move the scripts to a directory in your
46 $PATH.