From bd07c2bd35ffe9d522b2dfccf7f3866fb1924989 Mon Sep 17 00:00:00 2001 From: Taylor Turner Date: Fri, 16 Sep 2022 11:10:25 -0400 Subject: [PATCH] add testing docs in README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index aa9ea2bb7..65121f441 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,16 @@ If you want to run the `pre-commit` fresh over over all the files, run the follo pre-commit run --all-files ``` +## Testing +Before running unit tests, make sure you install the testing dependencies with `pip3 install -r requirements-test.txt`. + +To execute unit tests, run the following +```cli +DATAPROFILER_SEED=0 python3 -m unittest discover -p "test*.py" +``` + +For more nuanced testing runs, check out more detailed documentation [here](https://capitalone.github.io/DataProfiler/docs/0.7.11/html/install.html#testing). + ------------------ # What is a Data Profile?