README

README

@@ -1,31 +1,52 @@
 
-TODO (July 2019):
-	- refactor archive.py and search.py
-	- test lists import with mariadb backend
+[craw.py] [index.py] [search.py] [www-serve(.py)]
 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-usage: archive.py [-h] [--arch ARCH] url [url ...]
+usage: crawl.py [-h] [--names NAMES [NAMES ...]] [--archives ARCHIVES]
+                url [url ...]
 
 Mailinglists are dead. Long live mailinglists!
 
 positional arguments:
-  url          mailinglist urls to archive
+  url                   mailinglist urls to archive
 
 optional arguments:
-  -h, --help   show this help message and exit
-  --arch ARCH  path to archives directory (default='archives')
+  -h, --help            show this help message and exit
+  --names NAMES [NAMES ...], -n NAMES [NAMES ...]
+                        mailinglists' names
+  --archives ARCHIVES, -a ARCHIVES
+                        path to archives directory
 
-  ---
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-usage: search.py [-h] [--list LIST [LIST ...]] [--field FIELD] keyword
+usage: index.py [-h] [--archives ARCHIVES] list [list ...]
 
-Searches mailinglist's archives
+Mailinglists are dead. Long live mailinglists!
+
+positional arguments:
+  list                  list(s) to index
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --archives ARCHIVES, -a ARCHIVES
+                        path to archives directory (default='archives')
+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+usage: search.py [-h] [--list LIST [LIST ...]] [--field FIELD] [--json JSON]
+                 keyword
+
+Searches mailinglists archives
 
 positional arguments:
   keyword               keyword to search
 
 optional arguments:
   -h, --help            show this help message and exit
-  --list LIST [LIST ...]
-                        mailinglist(s') name(s)
-  --field FIELD         message field (i.e. 'content' or 'subject', etc.)
+  --list LIST [LIST ...], -l LIST [LIST ...]
+                        mailinglist(s') name(s) (default 'all')
+  --field FIELD, -f FIELD
+                        message field (i.e. 'content' or 'from' (default
+                        'content'))
+  --json JSON, -j JSON  json output