From 0a36628ddf3cdacf10583ac5e8c7b36d86b60662 Mon Sep 17 00:00:00 2001 From: Sarah Jamie Lewis Date: Tue, 25 Jun 2019 16:02:02 -0700 Subject: [PATCH] Documenting report format --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index c204460..7f034ec 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Raccoon - A tool for privately generating reports from data feeds +> You either build your own information processing pipelines or you become subject to someone else's. + I wanted a tool that would provide the following features: * Fetch data from the Internet at defined periods over Tor @@ -28,4 +30,23 @@ You can now run `raccoon update` to fetch all of your feeds over Tor. It will on To produce reports, you can run `raccoon report ` and raccoon will produce a markdown/html hybrid of a report that can be piped to a utility like `markdown` to produce a html report. +The `report.template` file can be customized as needed, some basic guidelines to the format: + +* Lines beginning with `%` are ignored +* Line beginning with `<` or `#` are printed as-is (for injecting HTML or markdown specifically) +* Report lines have the following (rought) format: + + ALL|DAY|WEEK|[0-9]* (Title|Link|Description)* +* Each report line can either print out a list of ALL items in the feed, or all items from the last DAY or the last WEEK, or a specific feed item (counting from 0) +* For each feed item you can print out the Title, Link & Description or any combination. + +Please see the report.template provided in this repository for a more complete example. + +You can also download images (or technically any other file) using a file called `images` in the directory (see the `pt-reyes` folder) - this is useful if you want to download specific data (like satellite images) from a resource that updates fairly often. + +## Notes + +You will need to be running a local `tor` proxy on port `9050` + +There is very little in the way of graceful error handling, contributions appreciated, please also feel free to submit issues & feature requests.