]> kaliko git repositories - python-musicpdaio.git/blob - doc/source/tutorial.rst
Add Sphinx documentation
[python-musicpdaio.git] / doc / source / tutorial.rst
1 .. _tutorial:
2
3 Tutorials
4 =========
5
6 Install
7 -------
8
9 For now the code is in early development stage. No releases are made.
10
11 .. code:: bash
12
13    # Use a virtualenv
14    python -m venv .../path/to/my/venv
15    . .../path/to/my/venv/bin/activate
16    pip install git+https://codeberg.org/MusicPlayerDaemon/python-musicpdaio.git@main
17
18
19 .. todo::
20
21    Updating a previous installation via `pip install git+https`.
22
23 Getting started
24 ----------------
25
26
27 .. literalinclude:: tutorial/tutorial-00.py
28
29
30 Concurrency
31 -----------
32
33 .. literalinclude:: tutorial/tutorial-01.py
34
35
36 .. vim: spell spelllang=en