1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 """
23 Overview
24 ========
25
26 The C{sabx10} meta-package provides all the functionality neaded to interact
27 with SABX 1.0 files. Although there are a lot of sub-packages in the C{sabx10}
28 package, they can be divided into three basic sets of functionality.
29
30 At the lowest level are the library packages that everything else is built on
31 top of. L{sabx10.oxm} takes care of reading in SABX 1.0 files, and
32 L{sabx10.templating} takes care of interacting with the Jinja2 templates that
33 everything else makes use of.
34
35 Next is the SABX 1.0 file-manipulation utility package, L{sabx10.utils}. This
36 contains the guts of all the scripts that allow for easy manipulation of SABX
37 1.0 files.
38
39 The final piece is the set of packages that facilitate turning the SABX 1.0
40 files into various types of maps. The L{sabx10.map} package generates HTML
41 maps. The L{sabx10.osm} package generates PDF pages with high-resolution map
42 images. The L{sabx10.profiles} package generates profile graphs of the rides
43 in the SABX 1.0 files. The L{sabx10.pdf_gen} package takes care of
44 miscellaneous tasks in generating single PDF maps for each ride from the
45 various pieces generated by the L{sabx10.osm} and L{sabx10.profiles} packages.
46
47 Copyright
48 =========
49
50 The sabx10 package is broken into two parts for licensing. The sub-package
51 sabx10.oxm is licensed under the less-restrictive Lesser GPLv3 license, while
52 the rest of the sabx10 package is licensed under the the regular GPLv3 license.
53 This is so that the sabx10.oxm code can be more easily used by other projects,
54 while the rest of sabx10 will be extended, rather than subsumed.
55
56 sabx10
57 ------
58
59 sabx10 - an SABX file manipulation library
60 Copyright (C) 2009, 2010 Jay Farrimond (jay@sabikerides.com)
61
62 sabx10 is free software: you can redistribute it and/or modify it under the
63 terms of the GNU Lesser General Public License as published by the Free
64 Software Foundation, either version 3 of the License, or (at your option) any
65 later version.
66
67 sabx10 is distributed in the hope that it will be useful, but WITHOUT ANY
68 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
69 PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
70 details.
71
72 You should have received a copy of the GNU Lesser General Public License along
73 with sabx10. If not, see U{http://www.gnu.org/licenses/}.
74
75 sabx10.oxm
76 ----------
77
78 The sabx10.oxm package constitutes sabx10.oxm.
79
80 sabx10.oxm - an SABX file manipulation library
81 Copyright (C) 2009, 2010 Jay Farrimond (jay@sabikerides.com)
82
83 sabx10.oxm is free software: you can redistribute it and/or modify it under the
84 terms of the GNU Lesser General Public License as published by the Free
85 Software Foundation, either version 3 of the License, or (at your option) any
86 later version.
87
88 sabx10.oxm is distributed in the hope that it will be useful, but WITHOUT ANY
89 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
90 PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
91 details.
92
93 You should have received a copy of the GNU Lesser General Public License along
94 with sabx10.oxm. If not, see U{http://www.gnu.org/licenses/}.
95 """
96