Permalink
Browse files

Update README

- Change name of project in readme
- Include usage information
  • Loading branch information...
1 parent 7829b46 commit 497b2d59d709f941961117e24af134b69e81cdc5 @vkurup committed Jan 9, 2013
Showing with 36 additions and 5 deletions.
  1. +36 −5 README.md
View
@@ -1,9 +1,9 @@
-TcxParser
-=========
+# python-tcxparser
-TcxParser is a minimal parser for Garmin's TCX file format. It is not
-in any way exhaustive. It simply extracts enough data to allow me to
-post data from my Garmin ForeRunner 410 watch to DailyMile's API.
+python-tcxparser is a minimal parser for Garmin's TCX file format. It
+is not in any way exhaustive. It extracts just enough data to allow me
+to post data from my Garmin ForeRunner 410 watch to
+[DailyMile's](http://dailymile.com) API.
Data extracted:
- latitude & longitude of start point of workout
@@ -13,4 +13,35 @@ Data extracted:
- duration of workout (in seconds)
- calories burned during workout (as estimated by device)
+## Installation
+
+ pip install python-tcxparser
+
+## Usage
+
+ >>> import tcxparser
+ >>> tcx = tcxparser.TcxParser('/home/vinod/Downloads/20121226-212953.tcx')
+ >>> # Duration of workout in seconds
+ ... tcx.duration
+ 1992.78
+ >>> # latitude/longitude at start of workout
+ ... tcx.latitude
+ 35.951880198
+ >>> tcx.longitude
+ -79.0931872185
+ >>> tcx.activity_type
+ 'running'
+ >>> # ISO UTC timestamp when workout completed
+ ... tcx.completed_at
+ '2012-12-26T22:03:05Z'
+ >>> # distance of workout in meters
+ ... tcx.distance
+ 4686.31103516
+ >>> tcx.distance_units
+ 'meters'
+ >>> # calories burned (as reported by device)
+ ... tcx.calories
+ 379
+
+## Contact
Please contact me with any questions: Vinod Kurup (vinod@kurup.com)

0 comments on commit 497b2d5

Please sign in to comment.