doc/bindings/python/source/installation.rst

   1 ..
   2    SPDX-FileCopyrightText: 2020 Philippe Proulx <eeppeliteloop@gmail.com>
   3    SPDX-License-Identifier: CC-BY-SA-4.0
   4
   5 .. include:: common.rst
   6
   7 Installation
   8 ============
   9 Linux distributions
  10 -------------------
  11 Linux distributions typically provide the Babeltrace |~| 2 Python
  12 bindings as the ``python3-bt2`` package.
  13
  14 Build and install from source
  15 -----------------------------
  16 When you
  17 `build Babeltrace 2 from source <https://babeltrace.org/#bt2-build-from-src>`_,
  18 specify the ``--enable-python-bindings`` option at configuration time,
  19 for example:
  20
  21 .. code-block:: text
  22
  23    $ ./configure --enable-python-bindings
  24
  25 If you also need the Babeltrace |~| 2 library (libbabeltrace2) to
  26 load Python plugins, specify the ``--enable-python-plugins`` option
  27 at configuration time:
  28
  29 .. code-block:: text
  30
  31    $ ./configure --enable-python-bindings --enable-python-plugins
  32
  33 See the project's
  34 :bt2link:`README <https://github.com/efficios/babeltrace/blob/stable-@ver@/README.adoc>`
  35 for build-time requirements and detailed build instructions.
  36
  37 .. note::
  38
  39    The Babeltrace |~| 2 Python bindings only work with Python |~| 3.