sarah
/
raccoon
1
3
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity

Documenting report format

This commit is contained in:
Sarah Jamie Lewis 2019-06-25 16:02:02 -07:00
parent dd4e7363e8
commit 0a36628ddf
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -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 <report.template>` 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:
<folder-name> 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.