CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# Building and installing Python bindings
|
|
|
|
Python bindings are available as wheels on [PyPI](https://pypi.org/project/google-benchmark/) for importing and
|
|
using Google Benchmark directly in Python.
|
|
Currently, pre-built wheels exist for macOS (both ARM64 and Intel x86), Linux x86-64 and 64-bit Windows.
|
|
Supported Python versions are Python 3.8 - 3.12.
|
|
|
|
To install Google Benchmark's Python bindings, run:
|
|
|
|
```bash
|
|
python -m pip install --upgrade pip # for manylinux2014 support
|
|
python -m pip install google-benchmark
|
|
```
|
|
|
|
In order to keep your system Python interpreter clean, it is advisable to run these commands in a virtual
|
|
environment. See the [official Python documentation](https://docs.python.org/3/library/venv.html)
|
|
on how to create virtual environments.
|
|
|
|
To build a wheel directly from source, you can follow these steps:
|
|
```bash
|
|
git clone https://github.com/google/benchmark.git
|
|
cd benchmark
|
|
# create a virtual environment and activate it
|
|
python3 -m venv venv --system-site-packages
|
|
source venv/bin/activate # .\venv\Scripts\Activate.ps1 on Windows
|
|
|
|
# upgrade Python's system-wide packages
|
|
python -m pip install --upgrade pip build
|
|
# builds the wheel and stores it in the directory "dist".
|
|
python -m build
|
|
```
|
|
|
|
NB: Building wheels from source requires Bazel. For platform-specific instructions on how to install Bazel,
|
|
refer to the [Bazel installation docs](https://bazel.build/install).
|