aboutsummaryrefslogtreecommitdiff
path: root/backend/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'backend/README.md')
-rw-r--r--backend/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/backend/README.md b/backend/README.md
index fc68183..0f3f332 100644
--- a/backend/README.md
+++ b/backend/README.md
@@ -1,5 +1,11 @@
# Files
-- **tolData**: Holds scripts for generating the tree-of-life database
-- **tilo.py**: WSGI script that serves data from the tree-of-life database. <br>
- Note: Using WSGI instead of CGI to avoid starting a new process for each request.
+- **tol_data/**: Holds scripts for generating the tree-of-life database
+- **tilo.py**: WSGI script that serves data from the tree-of-life database. <br>
+ Note: WSGI is used instead of CGI to avoid starting a new process for each request.
- **server.py**: Basic dev server that serves the WSGI script and image files
+- **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`