You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,9 +90,15 @@ Alternatively, you can set up Tusk Drift manually:
90
90
1. Install the SDK:
91
91
92
92
```bash
93
+
# Use Rust bindings for better performance
94
+
pip install tusk-drift-python-sdk[rust]
95
+
96
+
# Fallback if no platform-compatible wheel
93
97
pip install tusk-drift-python-sdk
94
98
```
95
99
100
+
*For more information about Rust acceleration, refer to [this doc](docs/rust-core-bindings).*
101
+
96
102
2. Create configuration: Run `tusk init` to create your `.tusk/config.yaml` config file interactively, or create it manually per the [configuration docs](https://github.com/Use-Tusk/tusk-drift-cli/blob/main/docs/configuration.md).
97
103
98
104
3. Initialize the SDK: Refer to the [initialization guide](docs/initialization.md) to instrument the SDK in your service.
If no wheel matches the environment, `pip` may attempt a source build of `drift-core-python`, which typically requires a Rust toolchain and native build prerequisites.
55
+
If no compatible wheel exists for your environment, `pip` may attempt a source build of `drift-core-python`, which typically requires a Rust toolchain and native build prerequisites.
57
56
58
57
## Fallback Behavior
59
58
@@ -62,6 +61,7 @@ The bridge module is fail-open:
62
61
- Rust calls are guarded.
63
62
- On import failures or call exceptions, the corresponding helper returns `None`.
64
63
- Calling code then uses the existing Python implementation.
64
+
- On startup, the SDK logs whether Rust is enabled/disabled and whether it had to fall back to Python.
65
65
66
66
This means users do not need Rust installed to run the SDK when Rust acceleration is disabled or unavailable.
67
67
@@ -80,7 +80,7 @@ Use with care:
80
80
81
81
## Practical Guidance
82
82
83
-
- Default production-safe posture: leave Rust disabled unless you have tested your deployment matrix.
83
+
- Default production-safe posture: keep Rust enabled (default) only on tested deployment matrices.
84
84
- Performance posture: enable Rust + benchmark on your workloads before broad rollout.
85
85
- Reliability posture: keep parity tests and smoke tests in CI to detect drift between Python and Rust paths.
0 commit comments