Ratings, subtitles, year in title
[xmltvtotgd.git] / README
blobaa2b9d32d0f0824e6f4349aa4a9c857e577c5389
1 icetotgd: Convert icetv's guide to Topfield TGD format.
4 * Running
6 To run, at the command line:
7 % python icetotgd.py
9 This will create a TGD file for every day of data. These TGD files
10 can then be uploaded to the Topfield (e.g. via Altair or Topfield ftpd)
11 and used by EPGupload or JustEPG.
14 * Source code
16 Source code is available on http://repo.or.cz/w/xmltvtotgd.git where
17 it can be downloaded (in .tar.gz or .zip format) or cloned (with git)
18 which I suggest you do if you want to muck around and submit patches.
20 You can run the unit tests directly
21 % python test_icetotgd.py
22 or with nosetests
23 % nosetests
26 * License
28 icetotgd is free open source software covered by the permissive MIT
29 license. See LICENSE for details.
32 * Known bugs
34 ** icetv's guide is in UTC, and is crudely converted to AEST,
35    this needs to be nicer.
37 ** TGD files are appended to - this probably isn't necessary,
38    because the ice guide is in sequence, but it means they
39    should be empty or nonexistent before this converter is run.
41 ** The rating isn't extracted from XML, all programmes are
42    rated X.
44 ** Some channels aren't converted properly. There's a crude hack
45    to work around this, which picks out only Melbourne channels.