Skip to content

Commit ec1e501

Browse files
committed
Demo and example, bumped garth
1 parent 9ea366a commit ec1e501

File tree

5 files changed

+3952
-2853
lines changed

5 files changed

+3952
-2853
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Python: Garmin Connect
22

3-
The Garmin Connect API demo (`example.py`) provides comprehensive access to **101 API methods** organized into **11 categories** for easy navigation:
3+
The Garmin Connect API library comes with two examples:
4+
5+
- **`example.py`** - Simple getting-started example showing authentication, token storage, and basic API calls
6+
- **`demo.py`** - Comprehensive demo providing access to **101 API methods** organized into **11 categories** for easy navigation
47

58
Note: The demo menu is generated dynamically; exact options may change between releases.
69

710
```bash
8-
$ ./example.py
9-
🏃‍♂️ Garmin Connect API Demo - Main Menu
11+
$ ./demo.py
12+
🏃‍♂️ Full-blown Garmin Connect API Demo - Main Menu
1013
==================================================
1114
Select a category:
1215

@@ -84,7 +87,12 @@ python3 -m venv .venv --copies
8487
source .venv/bin/activate # On Windows: .venv\Scripts\activate
8588
pip install pdm
8689
pdm install --group :example
90+
91+
# Run the simple example
8792
python3 ./example.py
93+
94+
# Run the comprehensive demo
95+
python3 ./demo.py
8896
```
8997

9098

@@ -322,7 +330,8 @@ print(f"Resting HR: {hr_data.get('restingHeartRate', 'n/a')}")
322330
```
323331

324332
### Additional Resources
325-
- **Source Code**: [example.py](https://raw.githubusercontent.com/cyberjunky/python-garminconnect/master/example.py)
333+
- **Simple Example**: [example.py](https://raw.githubusercontent.com/cyberjunky/python-garminconnect/master/example.py) - Getting started guide
334+
- **Comprehensive Demo**: [demo.py](https://raw.githubusercontent.com/cyberjunky/python-garminconnect/master/demo.py) - All 101 API methods
326335
- **API Documentation**: Comprehensive method documentation in source code
327336
- **Test Cases**: Real-world usage examples in `tests/` directory
328337

0 commit comments

Comments
 (0)