diff --git a/README b/README.md similarity index 55% rename from README rename to README.md index d81f6b3..34af969 100644 --- a/README +++ b/README.md @@ -1,13 +1,19 @@ +## Mailinglists are dead. Long live mailinglists! -[craw.py] [index.py] [search.py] [www-serve(.py)] +Research material for: + +* Dieter, M., Gauthier, D., & Tuters, M. (2019). Conversation pieces: On recounting new media art mailinglist cultures. _Internet Histories_, 3(3-4), 245-274. [doi.org/10.1080/24701475.2019.1674580](https://doi.org/10.1080/24701475.2019.1674580) + +Related project: [List server busy. Full digest rescheduled. A compendium of listserv discussions & divagations 1995-2019](https://davidgauthier.info/list-server-busy/) + + +[craw.py] [index.py] [search.py] [export.py] [report.py] +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - +``` usage: crawl.py [-h] [--names NAMES [NAMES ...]] [--archives ARCHIVES] url [url ...] -Mailinglists are dead. Long live mailinglists! - positional arguments: url mailinglist urls to archive @@ -17,13 +23,11 @@ optional arguments: mailinglists' names --archives ARCHIVES, -a ARCHIVES path to archives directory - +``` +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - +``` usage: index.py [-h] [--archives ARCHIVES] list [list ...] -Mailinglists are dead. Long live mailinglists! - positional arguments: list list(s) to index @@ -31,9 +35,9 @@ 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 @@ -42,7 +46,7 @@ Searches mailinglists archives positional arguments: keyword keyword to search -optional arguments: +options: -h, --help show this help message and exit --list LIST [LIST ...], -l LIST [LIST ...] mailinglist(s') name(s) (default 'all') @@ -50,3 +54,30 @@ optional arguments: message field (i.e. 'content' or 'from' (default 'content')) --json JSON, -j JSON json output +``` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +``` +usage: export.py [-h] [--out OUT] name + +Export mailinglists archives + +positional arguments: + name name of the archive to export + +options: + -h, --help show this help message and exit + --out OUT, -o OUT mbox output +``` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +``` +usage: report.py [-h] [--txt] lists [lists ...] + +Mailinglists report + +positional arguments: + lists lists to report + +options: + -h, --help show this help message and exit + --txt, -t output as text +```