From 15ceaa52715f7af4bc0c65f9141a55b836cc9f6e Mon Sep 17 00:00:00 2001 From: oclyke Date: Tue, 29 Apr 2025 18:23:06 -0700 Subject: [PATCH] docs(README.md): add basic contributing guide --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index c4df8eb..9ad69d7 100644 --- a/README.md +++ b/README.md @@ -199,3 +199,23 @@ table = client.query( print(table.to_pandas()) ``` You may also include your own root certificate via this manor aswell. + +# Contributing + +Tests are run using `pytest`. + +```bash +# Clone the repository +git clone https://github.com/InfluxCommunity/influxdb3-python +cd influxdb3-python + +# Create a virtual environment and activate it +python3 -m venv .venv +source .venv/bin/activate + +# Install the package and its dependencies +pip install -e .[pandas,polars,dataframe,test] + +# Run the tests +python -m pytest . +```