garminexport/README.md
petergardfjall c8c45c62e7 fixed typo
2014-11-09 13:57:50 +01:00

2.3 KiB

garminexport

The Garmin Connect activity exporter is a program that downloads all activities for a given Garmin Connect account and stores them locally on the user's computer.

Prerequisites

The instructions below for running the program (or importing the module) assumes that you have Python 2.7, pip, and virtualenv installed.

It also assumes that you have registered an account at Garmin Connect.

Getting started

Create and activate a new virtual environment to create an isolated development environment (that contains the required dependencies and nothing else).

virtualenv venv.garminexport
. venv.garminexport/bin/activate

Install the required dependencies in this virtual environment:

pip install -r requirements.txt

Run the program

The program is run as follows (use the --help flag for a list of available options).

./garminexport.py <username or email>

Once started, the program will prompt you for your account password and then log in to your Garmin Connect account to download all activities to a destination directory on your machine.

For each activity, these files are stored:

  • an activity summary file (JSON)

  • an activity details file (JSON)

  • an activity GPX file (XML)

  • an activity TCX file (XML)

  • an activity FIT file (binary) (if available -- the activity may have been entered manually rather than imported from a Garmin device).

All files are written to the same directory (activities/<timestamp>/ by default). Each activity file is prefixed by its upload timestamp and its activity id.

Library import

To install the development version of this library in your local Python environment, run:

pip install -e git://github.com/petergardfjall/garminexport.git#egg=garminexport

or if you prefer to use a requirements.txt file, add the following line to your list of dependencies:

-e -e git://github.com/petergardfjall/garminexport.git#egg=garminexport

and run pip with you dependency file as input:

pip install -r requirements.txt