garmin-connect-personal-api-python 1.0.0__tar.gz

garmin_connect_personal_api_python-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

garmin_connect_personal_api_python-1.0.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include examples *.py

garmin_connect_personal_api_python-1.0.0/PKG-INFO

@@ -0,0 +1,400 @@
+Metadata-Version: 2.4
+Name: garmin-connect-personal-api-python
+Version: 1.0.0
+Summary: Python client for the Garmin Connect Personal API
+Author: Garmin Ltd. or its subsidiaries.
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/garmin/connect-personal-api-python
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3,>=2.31
+Provides-Extra: interactive
+Requires-Dist: rich<15,>=13.7; extra == "interactive"
+Provides-Extra: dev
+Requires-Dist: garmin-connect-personal-api-python[interactive]; extra == "dev"
+Requires-Dist: pytest<9,>=8; extra == "dev"
+Requires-Dist: pytest-cov<7,>=5; extra == "dev"
+Requires-Dist: pyright<2,>=1.1; extra == "dev"
+Requires-Dist: ruff<1,>=0.9; extra == "dev"
+Dynamic: license-file
+
+# Garmin Connect Personal API Client
+
+A small Python client for reading data from Garmin's Personal API. It is a
+concrete example of how to query Garmin data using Personal API
+authentication, and other projects can reuse its parts independently:
+
+- `PersonalApiAuthenticator` caches bearer tokens and exchanges a Personal API
+  key for a new token when needed.
+- `GarminPersonalApiClient` makes authenticated GET requests with any bearer
+  token and provides convenience wrappers for Personal API data sets.
+- `gc-personal` is a command-line interface built on those same wrappers. Its
+  direct commands work in scripts and one-off queries, and an optional
+  interactive menu is included for demonstrating and exploring the data.
+
+## Requirements and installation
+
+You need Python 3.12 or newer and a Garmin Connect Personal API key. The
+package installs `requests` automatically.
+
+Create a virtual environment, activate it, and install the package:
+
+```shell
+python3 -m venv .venv
+source .venv/bin/activate
+python -m pip install garmin-connect-personal-api-python
+```
+
+On Windows, create and activate the environment with:
+
+```powershell
+py -3 -m venv .venv
+.venv\Scripts\Activate.ps1
+python -m pip install garmin-connect-personal-api-python
+```
+
+The base package supports authentication, data access, and direct CLI
+commands. Install the optional `interactive` extra to add `rich`, which
+interactive mode requires:
+
+```shell
+python -m pip install 'garmin-connect-personal-api-python[interactive]'
+```
+
+### Install from source
+
+To install without PyPI, run one of these commands from a clone of this
+repository:
+
+```shell
+python -m pip install .                 # library and direct CLI commands
+python -m pip install '.[interactive]'  # adds interactive mode
+python -m pip install -e '.[dev]'       # editable, with interactive mode and dev tools
+```
+
+## Authentication
+
+The package does not create Personal API keys. Create a key on
+[Garmin Connect](https://connect.garmin.com/app/settings/personalApiToken).
+
+### Command-line key sources
+
+`gc-personal` reads the key from one of these sources:
+
+1. **Key file:** `~/.config/garmin/connect-personal-api-key`, or another path
+   passed with `--api-key-file`. On Windows, `~` is your user profile folder
+   (`%USERPROFILE%`). The file should contain only the API key; surrounding
+   whitespace, including a trailing newline, is ignored.
+2. **Environment variable:** `GARMIN_PERSONAL_API_KEY`.
+3. **Command-line argument:** `--api-key`.
+
+If more than one source is provided, precedence is:
+
+1. Explicit key: `--api-key`.
+2. Explicit key file: `--api-key-file`, even if it names the default path.
+3. Environment variable: `GARMIN_PERSONAL_API_KEY`.
+4. Default key file, when neither explicit option nor the environment variable
+   supplies a key.
+
+A missing, unreadable, or empty explicitly selected file is an error, not a
+reason to fall back to the environment or default file. An empty explicit key
+or environment variable is also an error. **A key passed with `--api-key` may
+be exposed through shell history or the process list.**
+
+```shell
+# Use the default key file.
+gc-personal profile-settings
+
+# Use a key file at another path.
+gc-personal --api-key-file ~/my-garmin-key profile-settings
+
+# Use the environment variable.
+export GARMIN_PERSONAL_API_KEY='your-personal-api-key'
+gc-personal profile-settings
+
+# Pass the key directly (exposed to shell history and the process list).
+gc-personal --api-key 'your-personal-api-key' profile-settings
+```
+
+### Python key sources
+
+`obtain_token()` requires an explicit key and doesn't discover one itself;
+see [Explicit API key](#explicit-api-key).
+To opt into key discovery, pass the result of `resolve_api_key()` to
+`obtain_token()`; see [Key discovery](#key-discovery).
+An explicit `api_key` takes precedence over `key_file=`, which takes precedence
+over `GARMIN_PERSONAL_API_KEY`. When neither argument is supplied, discovery
+checks the environment variable and then the default key file.
+
+### Bearer-token cache
+
+The authenticator exchanges the API key for a bearer token and caches it by
+default in `~/.config/garmin/connect-personal-api-bearer-token.json`. Use
+`--bearer-token-cache-file` in the CLI, or `bearer_token_cache_file` in
+Python, to choose another location:
+
+```shell
+gc-personal --bearer-token-cache-file /path/to/bearer-token-cache.json profile-settings
+```
+
+A cached token is reused only when it was issued for the current API key and
+has more than one hour remaining before expiration, based on the JWT `exp`
+claim. Otherwise, the authenticator obtains and caches a new token. Each
+direct command, interactive session, and `obtain_token()` call checks the
+cache this way, so expired tokens are replaced automatically. The cache can't
+be disabled.
+
+Rarely, a token stops working before it expires, for example because it was
+revoked. Requests then fail with `401`, and the client doesn't retry them. To
+recover, obtain a new token:
+
+- **Direct commands:** run `gc-personal refresh-token`, or delete the cache
+  file, then rerun the command.
+- **Interactive mode:** choose **Reload Bearer Token** from the menu.
+- **Python:** call `obtain_token(api_key, force_refresh=True)`, then pass the
+  new token's `access_token` to `client.update_bearer_token()`.
+
+### Protecting credential files
+
+The bearer-token cache, and the key file if you use one, hold plain-text
+credentials. Keep them readable only by your user and out of version control.
+On POSIX systems, the package logs a warning, but continues, when either file
+is readable by group or other users. This check isn't performed on Windows.
+
+- **Key file:** Applies only when you provide the key through a key file
+  rather than the environment variable or an explicit argument. You create
+  this file, and it must contain only the key. Restrict its permissions
+  yourself, for example with `chmod 600`.
+- **Bearer-token cache:** The authenticator creates this file with `0600`
+  permissions on POSIX systems, so you don't need to set them yourself. An
+  existing cache file keeps its current permissions.
+
+## Command-line interface
+
+Use `--help` to list every command and shared option, or add it after a
+command to see that command's options and defaults:
+
+```shell
+gc-personal --help
+gc-personal steps --help
+```
+
+Run `gc-personal` with a command to retrieve data, download an activity file,
+or replace the cached bearer token:
+
+```shell
+gc-personal profile-settings
+gc-personal sleep --date 2026-08-24
+gc-personal steps --start-date 2026-08-20 --end-date 2026-08-24
+gc-personal activities --start 0 --limit 20 --start-date 2026-08-01
+gc-personal activity 123456789
+gc-personal activity-workouts 123456789
+gc-personal activity-download 123456789
+gc-personal activity-download 123456789 -o ./run.zip
+gc-personal refresh-token
+gc-personal --api-key-file /path/to/key --timeout 20 --quiet profile-settings
+```
+
+Most date options default to today when omitted. Shared options such as `--api-key-file` and `--timeout` go before the command. Use
+`--quiet` to suppress request logs for non-interactive commands; interactive
+status lines remain visible.
+
+Data commands print JSON to stdout. Request logs, status messages, and errors
+go to stderr, so output can be piped to other tools, such as `jq`. The command
+exits with a non-zero status on failure.
+
+`activity-download` saves a ZIP file as `activity-ID.zip` in the current
+directory unless `-o PATH` is given, and doesn't replace an existing file
+unless you pass `--force`. Use `-o -` to write the ZIP bytes to stdout; the
+command refuses to write them to a terminal.
+
+### Interactive Mode
+
+Interactive mode is a demonstration and data-exploration tool. Run
+`gc-personal` without a command to open its menu. Interactive mode requires
+the `interactive` extra. It loads the token through the same
+cache-aware authentication path as direct commands, reuses it for the session,
+and can force a new token to be obtained and cached from the menu.
+
+```shell
+gc-personal
+```
+
+Select an activity in the activity browser to view its details or workouts,
+or choose **download activity file** to save its ZIP file. The menu
+prompts for a destination and confirms before replacing an existing file.
+
+## Library usage
+
+The usual flow is to obtain a token, then pass it to the data client.
+
+### Explicit API key
+
+Pass your application's API key directly to `obtain_token()`. For example,
+an application with its own secret store can use:
+
+```python
+from garmin_personal_api import (
+    GarminPersonalApiClient,
+    PersonalApiAuthenticator,
+)
+
+api_key = my_app_secret_manager.get("garmin-personal-api-key")
+with PersonalApiAuthenticator() as authenticator:
+    token = authenticator.obtain_token(api_key)
+
+with GarminPersonalApiClient(token.access_token) as client:
+    sleep = client.get_daily_sleep("2026-08-24")
+    steps = client.get_daily_steps("2026-08-20", "2026-08-24")
+```
+
+`obtain_token()` returns a `BearerToken` with the token string in
+`access_token` and its expiration, in seconds since the epoch, in `expires_at`.
+Pass `force_refresh=True` to explicitly obtain and cache a new token.
+
+### Key discovery
+
+Alternatively, use `resolve_api_key()` to discover the key:
+
+```python
+from garmin_personal_api import PersonalApiAuthenticator, resolve_api_key
+
+with PersonalApiAuthenticator() as authenticator:
+    token = authenticator.obtain_token(resolve_api_key())
+```
+
+To explicitly select a key file, use
+`resolve_api_key(key_file="~/my-garmin-key")`. This overrides the environment
+variable, including when you explicitly select the default file path. If the
+selected file is missing, unreadable, or empty, discovery raises an error
+instead of trying another source.
+
+### Bearer tokens from another source
+
+Applications that already have a bearer token can skip the authenticator and
+use the data client directly:
+
+```python
+from garmin_personal_api import GarminPersonalApiClient
+
+with GarminPersonalApiClient(my_app_token_provider.get_token()) as client:
+    profile = client.get_user_profile_settings()
+```
+
+### Configuration
+
+Both classes accept an optional `requests.Session` and can be used as context
+managers or closed explicitly.
+
+Request activity is logged at `INFO` to the `garmin_personal_api` logger.
+Configure Python logging to see it.
+
+### Downloading activity files
+
+`download_activity()` returns ZIP bytes without writing or extracting files:
+
+```python
+from pathlib import Path
+
+with GarminPersonalApiClient(token.access_token) as client:
+    content = client.download_activity(123456789)
+    Path("activity-123456789.zip").write_bytes(content)
+```
+
+The whole ZIP is held in memory; streaming is not currently supported. Unlike the CLI,
+`Path.write_bytes()` overwrites an existing file.
+
+## Endpoint wrappers
+
+The table contains every dedicated wrapper on
+`GarminPersonalApiClient`. The CLI column shows the matching `gc-personal`
+command. `activity`, `activity-workouts`, and `activity-download` are direct commands but are not
+listed on the top-level interactive menu; see
+[Interactive Mode](#interactive-mode) for how to reach them interactively.
+
+Wrappers are added as a convenience and may lag behind new endpoints available
+through Personal API. Use `get()` for endpoints that don't have a wrapper;
+see [Call an endpoint without a wrapper](#call-an-endpoint-without-a-wrapper).
+
+| Python wrapper | CLI command | HTTP request |
+| --- | --- | --- |
+| `get_daily_stress(start_date, end_date)` | `stress` | `GET /usersummary-service/stats/stress/daily/{start_date}/{end_date}` |
+| `get_daily_steps(start_date, end_date)` | `steps` | `GET /usersummary-service/stats/steps/daily/{start_date}/{end_date}` |
+| `get_daily_hydration(start_date, end_date)` | `hydration` | `GET /usersummary-service/stats/hydration/daily/{start_date}/{end_date}` |
+| `get_effective_weight_goals(start_date, end_date)` | `effective-weight-goals` | `GET /goal-service/goal/user/effective/weightgoal/{start_date}/{end_date}` |
+| `get_weight_measurements(start_date, end_date)` | `weight-measurements` | `GET /weight-service/weight/range/{start_date}/{end_date}?includeAll=true` |
+| `get_daily_food_logs(calendar_date)` | `food-logs` | `GET /nutrition-service/food/logs/{calendar_date}` |
+| `get_user_profile_settings()` | `profile-settings` | `GET /userprofile-service/userprofile/settings` |
+| `get_daily_sleep(calendar_date)` | `sleep` | `GET /sleep-service/sleep/dailySleep?date={calendar_date}` |
+| `get_daily_sleep_summaries(start_date, end_date)` | `sleep-summaries` | `GET /sleep-service/sleep/dailySleepSummariesByDate?startDate={start_date}&endDate={end_date}` |
+| `get_daily_body_battery(start_date, end_date, *, chunks=None)` | `body-battery` | `GET /wellness-service/wellness/bodyBattery/reports/daily?startDate={start_date}&endDate={end_date}[&chunks={chunks}]` |
+| `get_daily_summaries(start_date, end_date)` | `daily-summaries` | `GET /usersummary-service/v2/dailysummaries?startDate={start_date}&endDate={end_date}` |
+| `get_daily_heart_rate(calendar_date)` | `heart-rate` | `GET /wellness-service/wellness/dailyHeartRate?date={calendar_date}` |
+| `get_daily_hrv(calendar_date)` | `hrv` | `GET /hrv-service/hrv/{calendar_date}` |
+| `get_daily_hrv_summaries(start_date, end_date)` | `hrv-summaries` | `GET /hrv-service/hrv/daily/{start_date}/{end_date}` |
+| `get_heart_rate_zones()` | `heart-rate-zones` | `GET /biometric-service/heartRateZones/v2` |
+| `get_menstrual_cycle_summary(calendar_date)` | `menstrual-cycle-summary` | `GET /periodichealth-service/menstrualcycle/summary/{calendar_date}` |
+| `get_menstrual_cycle_day_view(calendar_date, today_date)` | `menstrual-cycle-day-view` | `GET /periodichealth-service/menstrualcycle/dayview/{calendar_date}?todayDate={today_date}` |
+| `get_fitness_age(calendar_date)` | `fitness-age` | `GET /fitnessage-service/fitnessage/v2/{calendar_date}` |
+| `get_daily_spo2(calendar_date)` | `spo2` | `GET /wellness-service/wellness/daily/spo2acclimation/{calendar_date}` |
+| `get_wellness_activity_summaries(start_date, end_date)` | `wellness-activity-summaries` | `GET /wellnessactivity-service/activity/summary/range/{start_date}/{end_date}` |
+| `search_activities(*, start=0, limit=20, start_date=None, end_date=None, activity_type=None)` | `activities` | `GET /activitylist-service/activities/search/activities?start={start}&limit={limit}[&startDate={start_date}&endDate={end_date}&activityType={activity_type}]` |
+| `get_activity(activity_id)` | `activity` | `GET /activity-service/activity/{activity_id}` |
+| `get_activity_workouts(activity_id)` | `activity-workouts` | `GET /activity-service/activity/{activity_id}/workouts` |
+| `download_activity(activity_id)` | `activity-download` | `GET /download-service/files/activity/{activity_id}` (ZIP bytes) |
+
+Dates accept `datetime.date` objects or `YYYY-MM-DD` strings. Validation of
+dates, ranges, and other arguments is left to the API, except download activity
+IDs, which must be positive integers.
+
+### Call an endpoint without a wrapper
+
+Use `GarminPersonalApiClient.get()` for another Personal API GET endpoint:
+
+```python
+with GarminPersonalApiClient(token.access_token) as client:
+    custom_data = client.get(
+        "/some-service/some-resource",
+        params={"calendarDate": "2026-08-24"},
+    )
+```
+
+The client adds bearer-token authorization and returns decoded JSON. A
+successful response with no content returns `None`.
+
+## Errors
+
+- `GarminPersonalApiError` for missing or empty credentials, invalid local
+  settings such as a non-positive timeout or an invalid download activity ID,
+  an empty download response, or a token response that is not a JWT with an
+  `exp` claim.
+- `HttpError`, a subclass of `GarminPersonalApiError`, for unsuccessful token
+  or data responses. It exposes `status_code`, `method`, `url`, and
+  `response_text`.
+- `OSError` when an existing key file can't be read, or the bearer-token cache
+  can't be read or written, for example because of file permissions.
+
+Network failures and invalid JSON responses raise the underlying `requests`
+exceptions.
+
+## Development
+
+```shell
+ruff check .
+pyright
+pytest
+```
+
+Tests use HTTP test doubles and do not require credentials or network access.
+
+## License
+
+Copyright 2026 Garmin Ltd. or its subsidiaries. Distributed under the Apache
+2.0 License. See [LICENSE](LICENSE) for the complete license text.