]> kaliko git repositories - mpd-sima.git/blob - INSTALL
Sphinx documentation and API cleanup
[mpd-sima.git] / INSTALL
1 Designed for python3 >= 3.2
2
3 Requires: python-musicpd >= 0.4.0 [0],
4           requests >= 2.2.0 [1]
5
6         [0] http://media.kaliko.me/src/musicpd/releases/
7         [1] http://docs.python-requests.org/
8
9
10 Virtualenv installation:
11
12 With python >= 3.3:
13         Run "python3 ./vinstall.py" to generate the python virtualenv and install
14         requirements (need at least python 3.3).
15
16         It will setup a virtualenv within a "venv" directory (same level as vinstall.py file).
17         It should also write a shell wrapper to run mpd-sima within the virtualenv.
18
19                 ./vmpd-sima --help
20
21 For python < 3.3 or if you prefer manual installation:
22
23         # On your system <virtualenv_command> may be "pyenv", "python3 -m venv" or "virtualenv"
24         # Refer to the relevant manual to install a python env, 3.2 minimum.
25
26         <virtualenv_command> ./venv
27         . ./venv/bin/activate
28         ./setup.py install
29         ./venv/bin/mpd-sima --help