Skip to content

Commit

Permalink
Merge pull request #216 from cookieguru/patch-1
Browse files Browse the repository at this point in the history
Add links to GarminConnectConfig.json.example in README.md
  • Loading branch information
tcgoetz authored Dec 23, 2023
2 parents f1f09a1 + 7c94323 commit a724a83
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Plugins
Submodule Plugins updated 0 files
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ What they can do:
* Retain downloaded JSON and FIT files so that the DB can be regenerated without connecting to or redownloading data from Garmin Connect.
* Export activities as TCX files.

Once you have your data in the DB, I recommend using a supplied Jupyter notebooks, third party Jupyter notebooks, and/or SQLite browser like [SQLite Studio](http://sqlitestudio.pl) or [DB Browser for SQLite](https://sqlitebrowser.org/) for browsing and working with the data. The scripts create some default [views](http://www.tutorialspoint.com/sqlite/sqlite_views.htm) in the DBs that make browsing the data easier.
Once you have your data in the DB, I recommend using a supplied Jupyter notebooks, third party Jupyter notebooks, and/or SQLite browser like [SQLite Studio](http://sqlitestudio.pl), [HeidiSQL](https://www.heidisql.com/), or [DB Browser for SQLite](https://sqlitebrowser.org/) for browsing and working with the data. The scripts create some default [views](http://www.tutorialspoint.com/sqlite/sqlite_views.htm) in the DBs that make browsing the data easier.

# Using It

## Releases

GarminDb releases are hosted on [PyPI](https://pypi.org/project/garmindb/). GarminDb requires [Python](https://www.python.org/) 3.x. With Python installed, install the latest release with [pip](https://pypi.org/project/pip/) by running `pip install garmindb` in a terminal.
* 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.
* Copy [`GarminConnectConfig.json.example`](https://github.com/tcgoetz/GarminDB/raw/master/garmindb/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 dates 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.
* Ocassionally run `garmindb_cli.py --backup` to backup your DB files.
Expand All @@ -42,7 +42,7 @@ The scripts are automated with [Make](https://www.gnu.org/software/make/manual/m

* 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 `~/.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.
* Copy [`GarminConnectConfig.json.example`](https://github.com/tcgoetz/GarminDB/raw/master/garmindb/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 dates 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`.

Expand Down Expand Up @@ -71,7 +71,7 @@ Find out who's using GarminDb on what platforms, OSes, and python versions [here

* If you have issues, file a bug here on the project. See the Issues tab at the top of the project page. Run `make bugreport` or `garmindb_bug_report.py` and include bugreport.txt in your bug report.
* Besides errors that appear on the screen, one of the first places to look for more information is the log files (garmindb.log).
* If your having issues with a particular data files, please considering sharing so I can debug it and add support.
* If you're having issues with a particular data files, please considering sharing so I can debug it and add support.

# Contributing

Expand Down

0 comments on commit a724a83

Please sign in to comment.