third-party/benchmark/docs/python_bindings.md

   1 # Building and installing Python bindings
   2
   3 Python bindings are available as wheels on [PyPI](https://pypi.org/project/google-benchmark/) for importing and
   4 using Google Benchmark directly in Python.
   5 Currently, pre-built wheels exist for macOS (both ARM64 and Intel x86), Linux x86-64 and 64-bit Windows.
   6 Supported Python versions are Python 3.8 - 3.12.
   7
   8 To install Google Benchmark's Python bindings, run:
   9
  10 ```bash
  11 python -m pip install --upgrade pip  # for manylinux2014 support
  12 python -m pip install google-benchmark
  13 ```
  14
  15 In order to keep your system Python interpreter clean, it is advisable to run these commands in a virtual
  16 environment. See the [official Python documentation](https://docs.python.org/3/library/venv.html)
  17 on how to create virtual environments.
  18
  19 To build a wheel directly from source, you can follow these steps:
  20 ```bash
  21 git clone https://github.com/google/benchmark.git
  22 cd benchmark
  23 # create a virtual environment and activate it
  24 python3 -m venv venv --system-site-packages
  25 source venv/bin/activate  # .\venv\Scripts\Activate.ps1 on Windows
  26
  27 # upgrade Python's system-wide packages
  28 python -m pip install --upgrade pip build
  29 # builds the wheel and stores it in the directory "dist".
  30 python -m build
  31 ```
  32
  33 NB: Building wheels from source requires Bazel. For platform-specific instructions on how to install Bazel,
  34 refer to the [Bazel installation docs](https://bazel.build/install).