aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThéo de la Hogue2022-11-16 11:17:51 +0100
committerThéo de la Hogue2022-11-16 11:17:51 +0100
commitd0846c8a5a5ab7a66eeb79c2caee5bf87a98c4be (patch)
tree8033d9c38be032d727bd617dc8fb4e8f17b9f94f /README.md
parenteb5bf6508231d50f79090c43e7237cb9735eb7d8 (diff)
downloadargaze-d0846c8a5a5ab7a66eeb79c2caee5bf87a98c4be.zip
argaze-d0846c8a5a5ab7a66eeb79c2caee5bf87a98c4be.tar.gz
argaze-d0846c8a5a5ab7a66eeb79c2caee5bf87a98c4be.tar.bz2
argaze-d0846c8a5a5ab7a66eeb79c2caee5bf87a98c4be.tar.xz
Adding unitary tests.
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/README.md b/README.md
index ec27a80..2b9c0b7 100644
--- a/README.md
+++ b/README.md
@@ -20,13 +20,13 @@ Consider that all inline commands below needs to be executed into ArGaze root fo
pip install build
```
-- Then, build argaze package:
+- Then, build ArGaze package:
```
python -m build
```
-- Then, install argaze package (replace VERSION by what has been built into dist folder):
+- Then, install ArGaze package (replace VERSION by what has been built into dist folder):
```
pip install ./dist/argaze-VERSION.whl
@@ -71,4 +71,24 @@ pdoc -o ./doc ./src/argaze/
```
pdoc ./src/argaze/
- ``` \ No newline at end of file
+ ```
+
+## Test
+
+ArGaze package unitary tests are based on *unittest* module.
+Test files tree structure is mirroring the file tree structure of src/argaze folder.
+
+To run all unitary tests:
+
+```
+python -m unittest discover ./src/argaze.test "*.py"
+```
+
+To run only submodule unitary tests:
+
+```
+python -m unittest discover ./src/argaze.test/SUBMODULE "*.py"
+```
+
+.. note:: Verbose mode
+ *Use -v option to get more details.*