Add initial Python bindings documentation
[babeltrace.git] / doc / bindings / python / source / installation.rst
CommitLineData
ba64dfcc
SM
1.. include:: common.rst
2
3Installation
4============
5Linux distributions
6-------------------
7Linux distributions typically provide the Babeltrace |~| 2 Python
8bindings as the ``python3-bt2`` package.
9
10Build and install from source
11-----------------------------
12When you
13`build Babeltrace 2 from source <https://babeltrace.org/#bt2-build-from-src>`_,
14specify the ``--enable-python-bindings`` option at configuration time,
15for example:
16
17.. code-block:: text
18
19 $ ./configure --enable-python-bindings
20
21If you also need the Babeltrace |~| 2 library (libbabeltrace2) to
22load Python plugins, specify the ``--enable-python-plugins`` option
23at configuration time:
24
25.. code-block:: text
26
27 $ ./configure --enable-python-bindings --enable-python-plugins
28
29See the project's
30:bt2link:`README <https://github.com/efficios/babeltrace/blob/stable-@ver@/README.adoc>`
31for build-time requirements and detailed build instructions.
32
33.. note::
34
35 The Babeltrace |~| 2 Python bindings only work with Python |~| 3.
This page took 0.024158 seconds and 4 git commands to generate.