# retrace-cpython

> Patched CPython runtime artifacts and native probes for Retrace.

retrace-cpython builds patched CPython executables for Retrace. The
wheel package exposes retracesoftware_cpython.executable(), which
returns the packaged patched Python executable path. Patched
interpreters provide the public retrace module and the low-level
_retrace builtin for execution coordinates, thread scheduling
telemetry, call_at callbacks, deterministic identity hashes, and replay
handoff helpers.


## Start Here

- [Overview](https://retracesoftware.github.io/retrace-cpython/index.md): Project purpose, repository shape, and where to begin.
- [Runtime Package](https://retracesoftware.github.io/retrace-cpython/runtime-package/index.md): How to consume the PyPI wheel from other projects.

## Public Interfaces

- [Public API](https://retracesoftware.github.io/retrace-cpython/api/index.md): Public retrace and retracesoftware_cpython Python APIs.
- [Probe ABI](https://retracesoftware.github.io/retrace-cpython/probe-abi/index.md): Private native probe ABI and patched interpreter internals.

## Maintainers

- [Build And Release](https://retracesoftware.github.io/retrace-cpython/build-release/index.md): Local builds, docs generation, wheels, and release workflow.
- [Patch And Overlay Model](https://retracesoftware.github.io/retrace-cpython/patching/index.md): Patch stack and overlay rules.
- [Testing](https://retracesoftware.github.io/retrace-cpython/testing/index.md): Smoke tests, CPython tests, and release validation.
