GarminDB 开源项目使用教程

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

GarminDB 项目的目录结构如下：

GarminDB/
├── README.md
├── LICENSE
├── setup.py
├── requirements.txt
├── GarminDB/
│   ├── __init__.py
│   ├── config.py
│   ├── garmin_db.py
│   ├── fit_file.py
│   ├── json.py
│   ├── summary_db.py
│   ├── activities_db.py
│   ├── monitoring_db.py
│   ├── weight_db.py
│   ├── sleep_db.py
│   ├── stress_db.py
│   ├── settings_db.py
│   ├── utils.py
│   ├── export.py
│   ├── import.py
│   ├── update.py
│   ├── analyze.py
│   ├── plot.py
│   ├── cli.py
│   ├── notebooks/
│   │   ├── example_notebook.ipynb
│   │   └── ...
│   └── tests/
│       ├── test_garmin_db.py
│       └── ...
└── data/
    ├── garmin_db.sqlite
    └── ...

目录结构介绍

• README.md: 项目介绍和使用说明。
• LICENSE: 项目许可证。
• setup.py: 项目安装脚本。
• requirements.txt: 项目依赖包列表。
• GarminDB/: 项目主目录，包含所有源代码文件。
  • init.py: 包初始化文件。
  • config.py: 配置文件处理模块。
  • garmin_db.py: 主数据库处理模块。
  • fit_file.py: FIT 文件处理模块。
  • json.py: JSON 文件处理模块。
  • summary_db.py: 汇总数据库处理模块。
  • activities_db.py: 活动数据库处理模块。
  • monitoring_db.py: 监控数据库处理模块。
  • weight_db.py: 体重数据库处理模块。
  • sleep_db.py: 睡眠数据库处理模块。
  • stress_db.py: 压力数据库处理模块。
  • settings_db.py: 设置数据库处理模块。
  • utils.py: 工具函数模块。
  • export.py: 数据导出模块。
  • import.py: 数据导入模块。
  • update.py: 数据更新模块。
  • analyze.py: 数据分析模块。
  • plot.py: 数据可视化模块。
  • cli.py: 命令行接口模块。
  • notebooks/: Jupyter 笔记本示例目录。
  • tests/: 测试代码目录。
• data/: 数据存储目录。

2. 项目的启动文件介绍

GarminDB 项目的启动文件是 cli.py。这个文件提供了命令行接口，用户可以通过命令行来执行各种操作，如数据导入、更新、分析和可视化等。

启动文件介绍

• cli.py: 命令行接口模块，提供了以下功能：
  • 数据导入：从 Garmin Connect 下载数据并导入到 SQLite 数据库。
  • 数据更新：更新数据库中的数据。
  • 数据分析：对数据库中的数据进行分析。
  • 数据可视化：生成数据图表。

3. 项目的配置文件介绍

GarminDB 项目的配置文件是 config.py。这个文件包含了项目的配置选项，用户可以根据自己的需求进行配置。

配置文件介绍

• config.py: 配置文件处理模块，包含以下配置选项：
  • 数据库路径：指定 SQLite 数据库的存储路径。
  • 数据目录：指定数据文件的存储路径。
  • Garmin Connect 账号信息：用户名和密码。
  • 其他配置选项：如数据导入的频率、数据分析的参数等。

通过配置文件，用户可以灵活地调整项目的运行参数，以适应不同的使用场景。