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