diff options
| author | Terry Truong <terry06890@gmail.com> | 2022-10-03 23:42:36 +1100 |
|---|---|---|
| committer | Terry Truong <terry06890@gmail.com> | 2022-10-03 23:42:36 +1100 |
| commit | 243deedb6099c3a88ca44a7e26e72bceb65f562e (patch) | |
| tree | 806b9bea48f811c93103ecac83bc45a6377ac39a /backend/README.md | |
| parent | 5c0afa3e9a80fdcfa77bfc01b6373121f6ff3c6d (diff) | |
Add backend README
Diffstat (limited to 'backend/README.md')
| -rw-r--r-- | backend/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..a818b42 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,8 @@ +# Files +- `hist_data/`: Holds scripts for generating the history database and images +- `tests/`: Holds unit testing scripts <br> + Running all tests: `python -m unittest discover -s tests` <br> + Running a particular test: `python -m unittest tests/test_script1.py` <br> + Getting code coverage info (uses python package 'coverage'): <br> + 1. `coverage run -m unittest discover -s tests` + 2. `coverage report -m > report.txt` |