|
|
| (One intermediate revision by one other user not shown) |
| Line 1: |
Line 1: |
| = Introduction =
| | #REDIRECT [[EKG]] |
| | |
| From release 0.3.0 and onward, all EKG commands begin with the prefix <code>ekg-</code>
| |
| | |
| EKG currently supports two types of actions, scanning and graphing. Scanning iterates through a list of mailing lists and pulls down metadata on each post sent to that mailing list. It stores the subject, date and time, sender and records which mailing list it came from.
| |
| | |
| EKG also requires initial setup of a database to store the data. EKG works entirely through the current working directory it is called from. In order to run, it looks for a settings.ini file to specify which mailing lists to run from. A sample settings.ini is provided by the package in <code>/usr/share/doc/python-ekg-0.3.1/</code>. It creates a file <code>sqllite.db</code> which contains the metadata and multiple directories that are caches of the downloaded data.
| |
| | |
| EKG ships with the following three commands
| |
| | |
| *<code>ekg-generate-tables</code>
| |
| *<code>ekg-scan</code>
| |
| *<code>ekg-graph</code>
| |
| | |
| = First Time Setup =
| |
| | |
| To set up EKG to run in a particular directory, run the following command once.
| |
| | |
| <pre>
| |
| $ ekg-generate-tables
| |
| </pre>
| |
| | |
| Then, edit settings.ini to specify the mailing lists desired.
| |
| | |
| = Scanning =
| |
| | |
| Scanning can take several minutes for busy mailing lists the first time they are scanned. It seems currently the bottleneck is Internet bandwidth. On subsequent runs, scans are run incrementally. EKG will automatically discover which month on a particular mailing list has new messages and update only those months. If EKG fails to do so, please [[Developing EKG | file a bug]].
| |
| | |
| To scan:
| |
| | |
| <pre>
| |
| $ ekg-scan
| |
| </pre>
| |
| | |
| = Graphing =
| |
| | |
| Graphing is fairly quick. Currently, since EKG is in development, it does not provide sophisticated options.
| |
| | |
| Run:
| |
| <pre>
| |
| $ ekg-graph
| |
| </pre>
| |
