Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom Goetz committed Jun 18, 2021
1 parent 189c243 commit f45d1f4
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,22 @@ Once you have your data in the DB, I recommend using a SQLite browser like [SQLi

# Using It

## Binary Release
## Releases

Binary releases are available for MacOS. Binary release for other platforms may be added. You can download releases from the [release page](https://github.com/tcgoetz/GarminDB/releases).
Install the latest release with `pip install garmindb`.
* Copy `GarminConnectConfig.json.example` to `~/.garmindb/GarminConnectConfig.json`, edit it, and add your Garmin Connect username and password and adjust the start dates to match the dats of your data in Garmin Connect.
* Starting out: download all of your data and create your db by running `garmindb_cli.py --all --download --import --analyze` in a terminal.
* Incrementally update your db by downloading the latest data and importing it by running `garmindb_cli.py --all --download --import --analyze --latest` in a terminal.

Downloading and installing the MacOS binary release:
* Download the release zip file and unzip it into a directory where you want to keep the program and run it from.
* Follow the directions in the `Readme_MacOS.txt` in the zip file.
Update to the latest release with `pip install --upgrade garmindb`.

## From Source

The scripts are automated with [Make](https://www.gnu.org/software/make/manual/make.html). Run the Make commands in a terminal window.

* Git clone GarminDB repo using the [SSH clone method](https://github.com/git-guides/git-clone#git-clone-with-ssh). The submodules require you to use SSH and not HTTPS. Get the command from the green button on the project home page.
* Run `make setup` in the cloned tree to get the scripts ready to process data.
* Copy `GarminConnectConfig.json.example` to `GarminConnectConfig.json`, edit it, and add your Garmin Connect username and password and adjust the start dates to match the dats of your data in Garmin Connect.
* Copy `GarminConnectConfig.json.example` to `~/.garmindb/GarminConnectConfig.json`, edit it, and add your Garmin Connect username and password and adjust the start dates to match the dats of your data in Garmin Connect.
* Run `make create_dbs` once to fetch and process for you data.
* Keep all of your local data up to date by periodically running only one command: `make`.
* Ocassionally run `make backup` to backup your DBs files.
Expand Down
2 changes: 1 addition & 1 deletion scripts/garmindb_checkup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
from garmindb import ConfigManager, format_version


logging.basicConfig(filename='graphs.log', filemode='w', level=logging.INFO)
logging.basicConfig(filename='checkup.log', filemode='w', level=logging.INFO)
logger = logging.getLogger(__file__)
logger.addHandler(logging.StreamHandler(stream=sys.stdout))
root_logger = logging.getLogger()
Expand Down
2 changes: 1 addition & 1 deletion scripts/garmindb_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
from garmindb import OpenWithBaseCamp, OpenWithGoogleEarth


logging.basicConfig(filename='garmin.log', filemode='w', level=logging.INFO)
logging.basicConfig(filename='garmindb.log', filemode='w', level=logging.INFO)
logger = logging.getLogger(__file__)
logger.addHandler(logging.StreamHandler(stream=sys.stdout))
root_logger = logging.getLogger()
Expand Down
2 changes: 1 addition & 1 deletion utilities

0 comments on commit f45d1f4

Please sign in to comment.