docs: add python bindings

This commit is contained in:
JeanArhancet
2025-01-11 14:24:20 +01:00
parent 08844b80bb
commit ecf7f00cd8

View File

@@ -94,3 +94,18 @@ The `simulator` directory contains a deterministic simulator for testing.
What this means is that the behavior of a test run is deterministic based on the seed value.
If the simulator catches a bug, you can always reproduce the exact same sequence of events by passing the same seed.
The simulator also performs fault injection to discover interesting bugs.
## Python Bindings
Limbo provides Python bindings built on top of the [PyO3](https://pyo3.rs) project.
To compile the Python bindings locally, you need to have [Maturin](https://pypi.org/project/maturin/) installed:
```bash
pip install maturin
```
Once Maturin is installed, you can build the crate and install it as a Python module directly into the current virtual environment by running:
```bash
cd bindings/python && maturin develop
```