v1.0, 2010-1-28
Contact:
Jay Farrimond
jay@sabikerides.com
http://www.sabikerides.com/
This is a library that contains everything necessary to create, modify, and make maps from SABX 1.0 files. SABX 1.0 files contain data describing a bicycle ride. This includes things like stops, turns, directions, waypoints, photos, and other minutia.
Currently, the SABX format is at version 1.0. As new versions come out, new versions of the library will be added and old versions will be preserved. I do this because I don't expect everyone using SABX files to upgrade all at once when the format changes. The version 1.0 format library is called sabx10.
The oxm and templating sub-packages provide basic functionality shared by all the other sub-packages in sabx10. The oxm sub-package has code to read and parse SABX 1.0 files into a Python object hierarchy. The templating sub-package has code to help in using Jinja2 templates from the command-line.
The utils sub-package and its related scripts are a set of Python utilities to manage SABX 1.0 files.
The map, osm, pdf-gen, and profiles sub-packages, and their related scripts, are a set of Python utilities to generate maps from SABX files.
This library is currently developed and tested under Ubuntu 9.04, which defaults to Python 2.6.2. I'm not sure how well it works under other versions of Python and other operating systems, so keep an eye out for errors if you're using it on anything other than Ubuntu 9.04 and Python 2.6.
Documentation for the sabx10 package is in the html_docs directory included in the download and is also reproduced here.
The file TUTORIAL.html is a tutorial on creating and updating SABX files. It's included in the download as well as being reproduced here.
Documentation for each of the file manipulation utilities can be accessed by invoking them with the "-m" command-line option. It is also reproduced here for your convenience.
The file SETUP.html is a setup guide for the map-creation scripts. It's also included in the download.
Documentation for each of the map creation utilities can be accessed by invoking them with the "-m" command-line option. It is also reproduced here for your convenience.
The sabx10 package requires the Jinja2 Python package.
This is a standard Python package. Just unpack it, then run the following command (you may need to run it using sudo):
$ sudo python setup.py install
Once you have installed the package, the SETUP.html file (included in the package) contains instructions for setting-up and customizing SABX map creation.
The SABX 1.0 file format is described here.
| Version | Date | Description |
|---|---|---|
| v1.0 | 1/28/2010 | This is the initial release of the library. |
The sabx10 package is broken into two parts for licensing. The sub-package sabx10.oxm is licensed under the less-restrictive Lesser GPLv3 license, while the rest of the sabx10 package is licensed under the the regular GPLv3 license. This is so that the sabx10.oxm code can be more easily used by other projects, while the rest of sabx10 will be extended, rather than subsumed.
sabx10 - an SABX file manipulation library
Copyright (C) 2009, 2010 Jay Farrimond (jay@sabikerides.com)
This file is part of sabx10.
sabx10 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
sabx10 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with sabx10. If not, see http://www.gnu.org/licenses/.
The sabx10.oxm package constitutes sabx10.oxm.
sabx10.oxm - an SABX file manipulation library
Copyright (C) 2009, 2010 Jay Farrimond (jay@sabikerides.com)
sabx10.oxm is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
sabx10.oxm is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with sabx10.oxm. If not, see http://www.gnu.org/licenses/.