From 5de5fb93e50fe9006221b30ac4a66f1be0db82e7 Mon Sep 17 00:00:00 2001
From: Terry Truong <terry06890@gmail.com>
Date: Sun, 11 Sep 2022 14:55:42 +1000
Subject: Add backend unit tests

- Add unit testing code in backend/tests/
- Change to snake-case for script/file/directory names
- Use os.path.join() instead of '/'
- Refactor script code into function defs and a main-guard
- Make global vars all-caps

Some fixes:
- For getting descriptions, some wiki redirects weren't properly resolved
- Linked images were sub-optimally propagated
- Generation of reduced trees assumed a wiki-id association implied a description
- Tilo.py had potential null dereferences by not always using a reduced node set
- EOL image downloading didn't properly wait for all threads to end when finishing
---
 backend/tol_data/eol/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 backend/tol_data/eol/README.md

(limited to 'backend/tol_data/eol/README.md')

diff --git a/backend/tol_data/eol/README.md b/backend/tol_data/eol/README.md
new file mode 100644
index 0000000..580310d
--- /dev/null
+++ b/backend/tol_data/eol/README.md
@@ -0,0 +1,31 @@
+This directory holds files obtained via the [Encyclopedia of Life](https://eol.org/).
+
+# Mapping Files
+-   `provider_ids.csv.gz` <br>
+    Obtained from <https://opendata.eol.org/dataset/identifier-map> on 22/08/22 (says last updated 27/07/22).
+    Associates EOL IDs with taxon IDs from sources like NCBI and Index Fungorium.
+
+# Name Data Files
+-   `vernacularNames.csv` <br>
+    Obtained from <https://opendata.eol.org/dataset/vernacular-names> on 24/04/2022 (last updated on 27/10/2020).
+    Contains alternative-node-names data from EOL.
+
+# Image Metadata Files
+-   `imagesList.tgz` <br>
+    Obtained from <https://opendata.eol.org/dataset/images-list> on 24/04/2022 (last updated on 05/02/2020).
+    Contains metadata for images from EOL.
+-   `imagesList/` <br>
+    Extracted from imagesList.tgz.
+-   `gen_images_list_db.py` <br>
+    Creates a database, and imports imagesList/*.csv files into it.
+-   `images_list.db` <br>
+    Created by running genImagesListDb.py <br>
+    Tables: <br>
+    -   `images`:
+        `content_id INT PRIMARY KEY, page_id INT, source_url TEXT, copy_url TEXT, license TEXT, copyright_owner TEXT`
+
+# Image Generation Files
+-   `download_imgs.py` <br>
+    Used to download image files into imgs_for_review/.
+-   `review_imgs.py` <br>
+    Used to review images in imgs_for_review/, moving acceptable ones into imgs/.
-- 
cgit v1.2.3