This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sedona-db.git
The following commit(s) were added to refs/heads/main by this push:
new 69fd05b docs: Improve Python testing instructions in
`contributors-guide.md` (#184)
69fd05b is described below
commit 69fd05b1ee78be08259fc881c2c42c9bf6c2d7aa
Author: Peter Nguyen <[email protected]>
AuthorDate: Sun Oct 5 20:12:00 2025 -0700
docs: Improve Python testing instructions in `contributors-guide.md` (#184)
---
docs/contributors-guide.md | 40 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
diff --git a/docs/contributors-guide.md b/docs/contributors-guide.md
index 34589e7..9f801bd 100644
--- a/docs/contributors-guide.md
+++ b/docs/contributors-guide.md
@@ -155,6 +155,12 @@ native component with:
maturin develop
```
+If you don't yet have maturin installed, you can install it using pip
+
+```shell
+pip install maturin
+```
+
## Debugging
### Rust
@@ -175,6 +181,40 @@ Rust, C, or C++ code can be debugged using the
[CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)
*Attach to Process...* command from the command palette in VSCode.
+## Testing
+
+### Running Rust tests
+
+We use cargo to run the Rust tests.
+
+```shell
+cargo test
+```
+
+### Running Python tests
+
+A large number of the Python tests rely on a running PostGIS instance. You can
spin one up by using the providied PostGIS docker compose file.
+
+```shell
+docker compose up -d
+```
+
+You can later shut it down with
+
+```shell
+docker compose down
+```
+
+To run the actual Python tests, you can use pytest.
+
+e.g Run all of the tests
+
+```shell
+pytest python/sedonadb/tests
+```
+
+Remember that you need to run `maturin develop` to update your python
installation after changes in Rust code.
+
## Low-level benchmarking
Low-level Rust benchmarks use
[criterion](https://github.com/bheisler/criterion.rs).
