From 5a371c24fcae503799ae3d37f4c04bd83ef9141c Mon Sep 17 00:00:00 2001 From: Kyle Krafka Date: Mon, 18 May 2015 21:44:42 -0400 Subject: [PATCH] Add LICENSE and update README This should make usage (practically and legally) a little more clear. --- LICENSE | 22 ++++++++++++++++++++++ README.md | 12 ++++++++---- 2 files changed, 30 insertions(+), 4 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..90bd8fc --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2015 Kyle Krafka + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md index 1f929a6..07c06a3 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Usage: `python gcexport.py [how_many] [directory]` `[how_many]` specifies the number of recent activities you wish to download. You may also specify `all` to download everything. The default is `1`. -`[directory]` specifies the output directory for the CSV file and the GPX files. The default is a subdirectory with the format `YYYY-MM-DD_garmin_connect_export`. If the directory does not exist, it will be created. If it does exist, activities with existing GPX files will be skipped and the CSV file will be appended to. This should make it easy to restart failed downloads without repeating work. +`[directory]` specifies the output directory for the CSV file and the GPX files. The default is a subdirectory with the format `YYYY-MM-DD_garmin_connect_export`. If the directory does not exist, it will be created. If it does exist, activities with existing GPX files will be skipped and the CSV file will be appended to. This should make it easy to restart failed downloads without repeating work. This also allows you to specify a master directory so that this script can be run regularly (to maintain an up-to-date backup) without re-downloading everything. Example: `python gcexport.py all` will download all of your data to a dated directory. @@ -35,12 +35,16 @@ This script is for personal use only. It simulates a standard user session (i.e. History ------- -The original project was written in PHP (now in the `old` directory), based on "Garmin Connect export to Dailymile" code at http://www.ciscomonkey.net/gc-to-dm-export/. It no longer works due to the way Garmin handles logins. It could be updated, but I decided to rewrite everything in Python for the latest version. +The original project was written in PHP (now in the `old` directory), based on "Garmin Connect export to Dailymile" code at http://www.ciscomonkey.net/gc-to-dm-export/ (link has been down for a while). It no longer works due to the way Garmin handles logins. It could be updated, but I decided to rewrite everything in Python for the latest version. Contributions ------------- -Contributions are welcome, particularly if this script stops working with Garmin Connect. You might want to open a GitHub Issue first. +Contributions are welcome, particularly if this script stops working with Garmin Connect. You may consider opening a GitHub Issue first. New features, however simple, are encouraged. + +License +------- +[MIT](https://github.com/kjkjava/garmin-connect-export/blob/master/LICENSE) © 2015 Kyle Krafka Thank You --------- -Thanks for using this script and I hope you find it as useful as I do! +Thanks for using this script and I hope you find it as useful as I do! :smile: