Metadata-Version: 2.1
Name: karellen-rr
Version: 5.9.0.post137
Summary: rr reverse debugger
Home-page: https://github.com/karellen/karellen-rr
Author: Karellen, Inc.
Author-email: supervisor@karellen.co
Maintainer: Arcadiy Ivanov
Maintainer-email: arcadiy@karellen.co
License: Apache-2.0
Project-URL: Bug Tracker, https://github.com/karellen/karellen-rr/issues
Project-URL: Source Code, https://github.com/karellen/karellen-rr
Project-URL: Upstream, https://rr-project.org/
Keywords: rr,debugger,reverse-debugging,record-replay
Classifier: Programming Language :: Python
Classifier: Operating System :: POSIX :: Linux
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Debuggers
Description-Content-Type: text/markdown
Requires-Dist: wheel-axle-runtime <1.0

# Karellen rr

[![Gitter](https://img.shields.io/gitter/room/karellen/Lobby?logo=gitter)](https://app.gitter.im/#/room/#karellen_Lobby:gitter.im)
[![Build Status](https://img.shields.io/github/actions/workflow/status/karellen/karellen-rr/build.yml?branch=master)](https://github.com/karellen/karellen-rr/actions/workflows/build.yml)
[![Karellen rr Version](https://img.shields.io/pypi/v/karellen-rr?logo=pypi)](https://pypi.org/project/karellen-rr/)
[![Karellen rr Downloads Per Day](https://img.shields.io/pypi/dd/karellen-rr?logo=pypi)](https://pypistats.org/packages/karellen-rr)
[![Karellen rr Downloads Per Week](https://img.shields.io/pypi/dw/karellen-rr?logo=pypi)](https://pypistats.org/packages/karellen-rr)
[![Karellen rr Downloads Per Month](https://img.shields.io/pypi/dm/karellen-rr?logo=pypi)](https://pypistats.org/packages/karellen-rr)

[rr](https://rr-project.org/) reverse debugger packaged as a pip-installable
Python wheel for Linux x86_64 and aarch64.

## Overview

This project builds the `rr` reverse debugger inside a `manylinux_2_28` Docker
container and packages it as a `py3-none-manylinux_2_28_x86_64` wheel using
[wheel-axle](https://github.com/karellen/wheel-axle). The resulting wheel can
be installed with pip and provides the `rr` binary on PATH.

## Installation

```bash
pip install karellen-rr
```

After installation, `rr` is available directly:

```bash
rr record ./my-program
rr replay
```

## Building

### Prerequisites

- Docker
- Python 3.10+
- `wheel-axle` and `setuptools` (`pip install -r requirements.txt`)

### Build Steps

```bash
# Build rr inside manylinux_2_28 container
python docker-build.py

# Package on host
python packager.py -t rr.install

# Smoke test
bash test-build.sh
```

## Licenses

- **Packaging infrastructure** (this project): Apache License 2.0
- **rr**: MIT License (see `rr/LICENSE`)
- **Cap'n Proto**: MIT License (see `capnproto/LICENSE`)

All component licenses are bundled in the wheel under
`share/karellen-rr/licenses/`.
