From 5314c207ed43bcfd79b217ae6cc55f1c45d3e7aa Mon Sep 17 00:00:00 2001 From: Matthias Kestenholz Date: Sun, 3 Sep 2023 16:34:31 +0200 Subject: [PATCH] Add a development section to the README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index debd298a..19c35108 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,26 @@ Granian is currently under active development. Granian is compatible with Python 3.8 and above versions. +## Development + +You need installations of Rust and a recent Python 3 version. + + :::shell + # Set up a Python virtualenv + python3 -m venv .venv + source .venv/bin/activate + pip install -e .[test] + + # Rebuild the Rust library if you change any Rust code + cargo build + + # Run pytest + pytest + + # You may optionally speed up the test suite by running tests in parallel + pip install pytest-xdist + pytest -n 16 + ## License Granian is released under the BSD License.