Skip to content
This repository has been archived by the owner on Dec 9, 2020. It is now read-only.

Commit

Permalink
Update the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisroos committed Jan 6, 2011
1 parent c45ef7c commit 5b783e5
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
@@ -1,16 +1,20 @@
## Intro

Southeastern publish [Daily Performance reports](http://www.southeasternrailway.co.uk/your-journey/daily-performance/). They're not very usable as they are. This project currently contains the code I've used to parse that data and the parsed data itself.
Southeastern publish [Daily Performance reports](http://www.southeasternrailway.co.uk/your-journey/daily-performance/). They're not very usable as they are. This project contains a library, and some tools, to convert that data to splendid CSV.

I've also popped the data into [this Google Fusion table](http://www.google.com/fusiontables/DataSource?dsrcid=359310) and added a bit of a [query tool](http://chrisroos.github.com/southeastern-daily-performance/) and [dashboard](http://chrisroos.github.com/southeastern-daily-performance/dashboard.html) (of sorts).
If you're interested in analysing the data (rather than using this library to convert it) then checkout the [southeastern daily performance website](http://chrisroos.github.com/southeastern-daily-performance/).

## Installation

$ gem install southeastern-daily-performance

## Usage

# To convert a single html report to csv
$ sedpr-to-csv <location-of-html>

# To convert a directory containing multiple html reports to multiple csv reports
$ convert-all-html-data <location-of-html-reports> <location-of-csv-output>

## Examples

Expand Down Expand Up @@ -38,7 +42,5 @@ I've also popped the data into [this Google Fusion table](http://www.google.com/
## TODO

* 2010-04-21 breaks the parser...
* Ensure that I'm generating valid CSV (specifically that I'm quoting columns that contain commas)
* I currently have an empty file for 2010-11-30.csv. Investigate the cause.
* Republish the gem
* I'm getting 0s for the parsed overview from 2010-11-30. Investigate the cause.

0 comments on commit 5b783e5

Please sign in to comment.