garmin-running-data-normalizer 1.1.1__tar.gz

garmin_running_data_normalizer-1.1.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 tsubotti63
+
+   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_running_data_normalizer-1.1.1/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: garmin-running-data-normalizer
+Version: 1.1.1
+Summary: Deterministic local Garmin Account Export normalization primitives
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/tsubotti63/garmin-running-data-normalizer
+Project-URL: Repository, https://github.com/tsubotti63/garmin-running-data-normalizer
+Project-URL: Issues, https://github.com/tsubotti63/garmin-running-data-normalizer/issues
+Project-URL: Documentation, https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/product_quick_start.md
+Project-URL: Changelog, https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/product_changelog.md
+Keywords: garmin,running,normalization,fit
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest<9,>=8.4; extra == "test"
+Provides-Extra: release
+Requires-Dist: build<2,>=1.2; extra == "release"
+Requires-Dist: twine<7,>=6; extra == "release"
+Dynamic: license-file
+
+# Garmin Running Data Normalizer
+
+Garmin Running Data Normalizer is a local-first Python project for discovering
+an unmodified Garmin Account Export and producing deterministic,
+provenance-rich Garmin records without sending the export to a hosted service.
+
+## Current status
+
+The source repository is public and maintained on `main`. Version `1.1.1` is
+the Human-approved stable Production package candidate. It carries the reviewed
+v1.1 FIT integrity, relationship QA, and standalone Output Experience while
+preserving existing `1.x` CLI and output paths. The existing `v1.1.0` tag and
+[GitHub Release](https://github.com/tsubotti63/garmin-running-data-normalizer/releases/tag/v1.1.0)
+remain immutable; their tagged source declares `1.1.0rc1`, and those TestPyPI
+artifacts are not reused as stable Production artifacts. The `v1.1.1` tag,
+GitHub Release, TestPyPI upload, and Production PyPI upload remain separate
+Human Approval Boundaries.
+
+The formal CLI supports the existing activities-only Golden Path and a minimum
+multi-family Run-All workflow. Run-All requires Activities and processes Gear,
+Personal Records, and bounded FIT sessions/laps when those families are
+present. Public reproduction uses synthetic fixtures. A private real-export
+validation completed with status `PASS`, exit code 0, unchanged input, two
+independent byte-identical outputs, and a public-safe privacy check; no private
+rows, paths, identifiers, dates, filenames, hashes, or fingerprints are
+published. Only public-safe aggregate relationship acceptance counts are
+reported.
+
+This project is licensed under the
+[Apache License 2.0](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/LICENSE).
+
+The `1.0.0` scope aligns FIT Activity/Lap metric mappings and adds
+dependency-free library-level Sleep, HRV, and Health Status normalization.
+HRV uses the bounded FIT Message 370 candidate and keeps `healthStatusData`
+comparison as validation evidence only. Health Status emits complete long and
+fixed daily schemas without dynamic columns. These families are not yet part of
+the formal CLI or Run-All public output contract.
+
+## Supported datasets and interfaces
+
+| Dataset or output | Implemented scope | Formal CLI support |
+|---|---|---|
+| Activities | `summarizedActivities.json` normalization with activity grain, `garmin_activity_key`, provenance, QA, and manifest | Yes |
+| Gear and activity-gear links | `gear.json` normalizer | Run-All |
+| Personal records | `personalRecord.json` normalizer | Run-All |
+| FIT sessions and laps | CRC-validated multi-session parser with `fit_session_key` and `fit_lap_key`; record coordinates and raw telemetry are not emitted | Run-All |
+| Activity/FIT links | Auditable evidence-qualified links with exclusions and relationship QA | Run-All |
+| Sleep | `sleepData.json` daily normalization with review states and provenance; no filling or inference | No; library level only |
+| HRV | FIT Message 370 / Field 1 daily candidate with invalid-sentinel handling and non-promotional JSON consistency evidence | No; library level only |
+| Health Status | Exact-suffix `healthStatusData.json` long metrics and fixed daily schema with explicit dedupe/review evidence | No; library level only |
+| Analysis Pack | Deterministic allowlist-only ZIP; optional external-safe profile is limited to month-level activity volume/count and removes identifiers, provenance, exact timestamps, and unneeded health/performance detail | Run-All opt-in |
+
+The dataset registry documents stable keys, record grain, merge policy, and
+provenance requirements. See the
+[Supported Datasets](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/supported_datasets.md)
+for the stable CLI/output boundary and library-level scope.
+
+## Install
+
+Garmin Running Data Normalizer requires Python 3.11 or later:
+
+Production PyPI publication has not yet been performed. Until the `v1.1.1` tag
+and package-index release are separately authorized, install the earlier
+reviewed stable tag from a checkout:
+
+```bash
+git clone --branch v1.0.0 --depth 1 \
+  https://github.com/tsubotti63/garmin-running-data-normalizer.git
+cd garmin-running-data-normalizer
+python3 -m venv .venv
+source .venv/bin/activate
+python -m pip install .
+python -m garmin_running_data_normalizer --version
+```
+
+The equivalent installed console command is `garmin-running-data-normalizer`.
+The project has no third-party runtime package dependency.
+
+After a separate PyPI publication is completed, the canonical index install
+command will be:
+
+```bash
+python -m pip install garmin-running-data-normalizer
+```
+
+Maintainers can reproduce the packaging gate without uploading anything:
+
+```bash
+python -m pip install -e '.[test,release]'
+python -m build
+python -m twine check --strict dist/*
+```
+
+## Try the synthetic Golden Path
+
+No Garmin account or real export is required. After local installation, run the
+bounded activities workflow with the visibly synthetic fixture:
+
+```bash
+python -m garmin_running_data_normalizer normalize-activities --input examples/synthetic/garmin_export --output workspace/golden-path
+```
+
+It creates deterministic normalized activities, a QA summary, and a provenance
+manifest without modifying the input. Follow the complete copy-and-paste setup,
+Golden Result comparison, repeat-run check, privacy guidance, and current
+limitations in the
+[Product Quick Start](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/product_quick_start.md).
+
+## Run the minimum multi-family workflow
+
+Use a new output directory for every run:
+
+```bash
+python -m garmin_running_data_normalizer run-all \
+  --input examples/synthetic/garmin_export \
+  --output workspace/run-all
+```
+
+The tracked fixture contains Activities only, so this tested example returns
+`PASS_WITH_WARNINGS` with exit code 0 and records the absent optional families.
+Run-All writes normalized JSON, FIT and relationship audit, deterministic
+Activities CSV, dataset and relationship QA, three human-readable handoff
+documents, machine-readable analysis/schema context, a run manifest, and
+`run_summary.json` as its completion marker. `START_HERE.md`,
+`ANALYSIS_HANDOFF.md`, and `ANALYSIS_CONTEXT.json` report coverage for every
+explicit relationship without hiding unresolved, ambiguous, or duplicate
+records; detailed evidence remains in relationship QA and audit artifacts.
+Exit code 2 is fatal; exit code 3 is an explicit `PARTIAL_SUCCESS` for auditable
+incomplete FIT parsing. See the
+[Product Quick Start](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/product_quick_start.md)
+for the additive v1.1 output layout and privacy boundary. Add
+`--external-safe-pack` to create a deterministic reviewable ZIP; Run-All never
+uploads it.
+
+Full normalized JSON and audit output use the `local_trusted_full` privacy mode.
+They can retain memo text and source-relative Garmin filenames, including
+email-shaped personal identifiers. Keep them local; the optional external-safe
+pack removes those fields.
+
+## Why this project matters
+
+Run-All creates a reviewable boundary between a complex local Garmin export and
+downstream analysis: deterministic normalization, fixed output, QA and
+provenance, explicit warnings, and a separate human-owned interpretation step.
+See the
+[Primary Case Study](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/docs/case_studies/from_garmin_export_to_reproducible_analysis_handoff_v0_1.md).
+
+## Analyze Run-All output
+
+Review generated `START_HERE.md` first. In a trusted local environment, follow
+`DATASET_INVENTORY.md` and `ANALYSIS_HANDOFF.md`, then start with
+`analysis/activities.csv` and the
+[Analysis Handoff Specification](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/project/analysis_handoff_spec_v0_1.md).
+The [Run-All Output Contract](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/output_contract.md),
+[Dataset Catalog](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/supported_datasets.md),
+and [Dataset Relationship Catalog](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/dataset_relationships.md)
+explain artifact authority, dataset roles, and the explicit v1.1 joins.
+The [prompt template](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/docs/project/analysis_prompt_template_v0_1.md),
+[public usage example](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/docs/project/run_all_public_usage_example_v0_1.md), and
+[use-case catalog](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/docs/project/run_all_use_case_catalog_v0_1.md) separate facts,
+calculations, interpretation, and unknowns.
+
+Three key-free synthetic examples are available:
+
+- [Monthly and Weekly Training Trends](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/examples/analysis/monthly_weekly_training_trends/README.md)
+- [Pace and Heart Rate Relationship](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/examples/analysis/pace_heart_rate_relationship/README.md)
+- [Training Consistency and Return Pattern](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/examples/analysis/training_consistency_return_pattern/README.md)
+
+Calculated facts are reproducible; generative wording is not claimed to be
+byte-identical. The current `garmin_activity_key` may incorporate a source
+activity ID. Keep real CSV local, remove that key from any externally shared
+derivative, and review exact date/time granularity before transfer.
+
+## Local verification
+
+```bash
+PYTHONPATH=src python3 -m unittest discover -s tests -v
+python3 scripts/validate_bootstrap.py
+python3 scripts/static_policy_scan.py
+python3 scripts/validate_platform_alignment.py
+python3 scripts/validate_public_history.py --ci
+```
+
+The public-history command assumes a normal public clone whose `origin/HEAD`
+points to `origin/main`. The no-argument mode is intentionally reserved for the
+historical pre-registration checkout contract.
+
+Only synthetic fixtures may be committed. Real Garmin exports and generated
+personal output belong in ignored local directories.
+
+## Activities Golden Path guarantees
+
+- The documented Golden Path produces byte-identical JSON for identical input.
+- Input is read-only; output must be absent or empty and is never silently
+  overwritten.
+- ZIP input is validated for traversal, links, encryption, entry count, size,
+  total size, and compression-ratio limits.
+- Stable keys, activity record grain, source-relative provenance, hashes, and
+  deterministic QA are included in the reviewed output contract.
+- Unsupported or unsafe Golden Path input fails closed with a non-zero exit
+  status.
+
+## Known limitations
+
+Run-All v1 requires Activities; Gear, Personal Records, and FIT are optional.
+Sleep, HRV, and Health Status are library-level interfaces and are not Run-All
+outputs. Hosted processing, Open-Meteo, Parquet, automatic upload, and
+Production PyPI publication are not included. The
+documented CLI and versioned Run-All output contract are the stable `1.x`
+interface; other Python modules may evolve compatibly as their contracts mature.
+See
+[Known Limitations](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/known_limitations.md)
+for the precise boundaries.
+
+## Non-goals
+
+Hosted processing, Garmin account authentication, JMA or Instagram ingestion,
+wellness/coaching interpretation, personal analysis, and non-Garmin data
+platform generalization are outside the project scope.
+
+See the
+[Product Change History](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/main/docs/product_changelog.md)
+for factual product
+changes. The root `CHANGELOG.md` is the byte-locked change log of the adopted AI
+Collaboration Platform v0.9 Standard, not a Garmin product release history.
+
+## Project map
+
+- `docs/project_os/`: unmodified AI Collaboration Platform v0.9 Standard
+- `docs/project/`: Project Customization and current phase controls
+- `docs/proofs/`: Platform capability evidence
+- `docs/reference/`: reuse, privacy, licensing, release, and handoff references
+- `templates/`: unmodified Platform project/operation templates
+- `runtime/`: unmodified Platform runtime plus Target Runtime Addendum
+- `src/garmin_running_data_normalizer/`: public product implementation
+- `tests/`: synthetic, dependency-free unit tests
+- `packages/`: tracked package policy; review packs are generated under ignored
+  `.review/`
+
+Start with
+[`docs/README.md`](https://github.com/tsubotti63/garmin-running-data-normalizer/blob/v1.0.0/docs/README.md).