From Fedora Project Wiki

(Created page with '= Introduction = 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. Sca...')
 
(updated commands)
Line 5: Line 5:
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 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 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.4.0/</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
EKG ships with the following three commands


*<code>ekg-generate-tables</code>
*<code>ekg-migrate</code>
*<code>ekg-create-db</code>
*<code>ekg-upgrade</code>
*<code>ekg-setup</code>
*<code>ekg-scan</code>
*<code>ekg-scan</code>
*<code>ekg-graph</code>
*<code>ekg-graph</code>
<code>ekg-create-db</code> is provided as a way to initialize the database and it is used by other functionality. It's included in this list for completeness, but it's not necessary to know anything more about. This paragraph alone is a waste of space and time. We make no apologies.


= First Time Setup =
= First Time Setup =


To set up EKG to run in a particular directory, run the following command once.
To set up EKG to run in a particular directory, run the following command once.
Be sure it points to the right database before starting.


<pre>
<pre>
$ ekg-generate-tables
$ ekg-setup
</pre>
</pre>


Line 40: Line 47:
<pre>
<pre>
$ ekg-graph
$ ekg-graph
</pre>
= Upgrading =
When upgrading EKG, if there are any database changes, it is easy to update your db to match the new schema.
Run:
<pre>
$ ekg-upgrade
</pre>
= Migrate =
EKG actually just embeds SQLAlchemy-Migrate in order to handle upgrades. If you want access to the underlying layer, there is a command, migrate, that is provided. It uses the database specified in the settings.ini file, and the repository that ships with EKG.
<pre>
$ ekg-migrate
</pre>
</pre>

Revision as of 14:35, 4 June 2009

Introduction

From release 0.3.0 and onward, all EKG commands begin with the prefix ekg-

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 /usr/share/doc/python-ekg-0.4.0/. It creates a file sqllite.db which contains the metadata and multiple directories that are caches of the downloaded data.

EKG ships with the following three commands

  • ekg-migrate
  • ekg-create-db
  • ekg-upgrade
  • ekg-setup
  • ekg-scan
  • ekg-graph

ekg-create-db is provided as a way to initialize the database and it is used by other functionality. It's included in this list for completeness, but it's not necessary to know anything more about. This paragraph alone is a waste of space and time. We make no apologies.

First Time Setup

To set up EKG to run in a particular directory, run the following command once.

Be sure it points to the right database before starting.

$ ekg-setup

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 file a bug.

To scan:

$ ekg-scan

Graphing

Graphing is fairly quick. Currently, since EKG is in development, it does not provide sophisticated options.

Run:

$ ekg-graph

Upgrading

When upgrading EKG, if there are any database changes, it is easy to update your db to match the new schema.

Run:

$ ekg-upgrade

Migrate

EKG actually just embeds SQLAlchemy-Migrate in order to handle upgrades. If you want access to the underlying layer, there is a command, migrate, that is provided. It uses the database specified in the settings.ini file, and the repository that ships with EKG.

$ ekg-migrate