From d32a2a6fef7901a73cdea241eebde04be7ce492e Mon Sep 17 00:00:00 2001 From: markur <98951648+markur4@users.noreply.github.com> Date: Thu, 30 Nov 2023 16:14:21 +0100 Subject: [PATCH] added instructions how to test this software --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 409563a..ad7bf6c 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,10 @@ black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://gith # Installation 📦 ``` bash +# Install from PyPi: pip install plotastic -# or + +# For the latest version (check CHANGELOG.md!): pip install git+https://github.com/markur4/plotastic.git ``` @@ -1045,3 +1047,12 @@ plt.savefig("example.png", dpi=200, bbox_inches="tight") +# 🧪 Testing +- Download/Clone repository +- Install development tools `pip install .[dev]` +- Run tests + - Run `pytest ./tests` + - To include a coverage report run + `pytest ./tests -cov--cov-report=html` and open + `./htmlcov/index.html` with your browser. +