GarminDB 项目使用教程

GarminDB 项目使用教程

GarminDB Download and parse data from Garmin Connect or a Garmin watch, FitBit CSV, and MS Health CSV files into and analyze data in Sqlite serverless databases with Jupyter notebooks. 项目地址: https://gitcode.com/gh_mirrors/ga/GarminDB

1. 项目的目录结构及介绍

GarminDB 项目的目录结构如下：

GarminDB/
├── garmindb/
│   ├── __init__.py
│   ├── garmindb_cli.py
│   ├── ...
├── Jupyter/
│   ├── analysis_notebook.ipynb
│   ├── ...
├── Plugins/
│   ├── plugin_example.py
│   ├── ...
├── Screenshots/
│   ├── screenshot1.png
│   ├── ...
├── Tcx/
│   ├── tcx_parser.py
│   ├── ...
├── scripts/
│   ├── download_data.py
│   ├── ...
├── test/
│   ├── test_garmindb.py
│   ├── ...
├── utilities/
│   ├── utils.py
│   ├── ...
├── .gitignore
├── .gitmodules
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── contributors.txt
├── defines.mk
├── dev-requirements.in
├── dev-requirements.txt
├── pyproject.toml
├── requirements.in
├── requirements.txt
├── setup.py

目录结构介绍

• garmindb/: 包含项目的主要代码文件，如 garmindb_cli.py 是项目的启动文件。
• Jupyter/: 包含用于数据分析的 Jupyter Notebook 文件。
• Plugins/: 包含扩展项目功能的插件文件。
• Screenshots/: 包含项目的截图文件。
• Tcx/: 包含处理 TCX 文件的代码文件。
• scripts/: 包含用于下载和处理数据的脚本文件。
• test/: 包含项目的测试文件。
• utilities/: 包含项目的实用工具文件。
• 其他文件: 如 .gitignore, .gitmodules, LICENSE, MANIFEST.in, Makefile, README.md, contributors.txt, defines.mk, dev-requirements.in, dev-requirements.txt, pyproject.toml, requirements.in, requirements.txt, setup.py 等，这些文件用于项目的配置、构建和文档。

2. 项目的启动文件介绍

项目的启动文件是 garmindb/garmindb_cli.py。该文件是一个命令行接口（CLI），用于执行项目的各种操作，如数据下载、导入、分析等。

主要功能

• 数据下载: 从 Garmin Connect 下载用户的健康数据。
• 数据导入: 将下载的数据导入到 SQLite 数据库中。
• 数据分析: 对导入的数据进行分析，并生成报告。

使用方法

在终端中运行以下命令启动项目：

python garmindb/garmindb_cli.py --all --download --import --analyze

3. 项目的配置文件介绍

项目的配置文件是 GarminConnectConfig.json。该文件用于配置用户在 Garmin Connect 的登录信息和其他相关设置。

配置文件内容

{
    "username": "your_username",
    "password": "your_password",
    "start_date": "2020-01-01"
}

配置文件路径

配置文件应放置在用户主目录下的 GarminDb/ 文件夹中，文件名为 GarminConnectConfig.json。

配置文件说明

• username: 用户在 Garmin Connect 的登录用户名。
• password: 用户在 Garmin Connect 的登录密码。
• start_date: 数据下载的起始日期，格式为 YYYY-MM-DD。

通过以上配置，项目可以自动下载和处理用户的健康数据，并将其存储在 SQLite 数据库中，方便后续的数据分析和可视化。

GarminDB Download and parse data from Garmin Connect or a Garmin watch, FitBit CSV, and MS Health CSV files into and analyze data in Sqlite serverless databases with Jupyter notebooks. 项目地址: https://gitcode.com/gh_mirrors/ga/GarminDB