fleetpull 0.1.0__tar.gz

fleetpull-0.1.0/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 Andrew Jordan
+
+   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.

fleetpull-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: fleetpull
+Version: 0.1.0
+Summary: Pull fleet telematics data from provider APIs (Motive, Samsara, GeoTab) into typed polars DataFrames and parquet: retrieval, dtype coercion, and light structural normalization — no assumed end use.
+Author-email: Andrew Jordan <andrewjordan3@gmail.com>
+Maintainer-email: Andrew Jordan <andrewjordan3@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/andrewjordan3/fleetpull
+Project-URL: Repository, https://github.com/andrewjordan3/fleetpull
+Project-URL: Issues, https://github.com/andrewjordan3/fleetpull/issues
+Keywords: telematics,fleet,motive,samsara,geotab,polars,api-client
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: polars>=1.0.0
+Requires-Dist: pydantic>=2.7.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: truststore>=0.9.0
+Requires-Dist: tzdata>=2025.2
+Provides-Extra: dev
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: mypy>=1.10.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: import-linter>=2.0; extra == "dev"
+Requires-Dist: types-pyyaml; extra == "dev"
+Dynamic: license-file
+
+# fleetpull
+
+fleetpull pulls fleet telematics data from provider APIs — **Motive**,
+**Samsara**, and **GeoTab** — and delivers it as typed, dtype-coerced,
+lightly normalized tabular output: Polars DataFrames in memory, parquet on
+disk, staying as close to the raw API responses as is reasonable.
+
+It is deliberately narrow. fleetpull does no cross-endpoint merging, builds
+no unified cross-provider schema, performs no semantic deduplication, loads
+no warehouse, and assumes no end use — downstream processing is the
+consumer's concern. What it does instead is be rigorous about retrieval:
+probed (never merely documented) provider behavior, crash-safe incremental
+state, token-bucket rate limiting at the transport boundary, and one
+explicit schema per (provider, endpoint).
+
+**Status:** alpha. The two public verbs below are settled, and coverage is
+broad — the Motive and Samsara endpoint inventories and the GeoTab `Get` and
+feed surfaces are all shipped (see [ENDPOINTS.md](ENDPOINTS.md)). Pre-1.0,
+the internals are still free to improve.
+
+## Install
+
+```bash
+pip install fleetpull
+# or
+uv add fleetpull
+```
+
+The latest development version, straight from source:
+
+```bash
+pip install git+https://github.com/andrewjordan3/fleetpull
+```
+
+Python ≥ 3.12. Core dependencies: `httpx`, `polars`, `pydantic` 2.x,
+`pyyaml`, `truststore`, `tzdata`.
+
+To scaffold a starter config for the `sync` verb below, run
+`fleetpull init-config` — it writes an annotated `fleetpull_config.yaml`
+you edit and point `sync` at.
+
+## The two verbs
+
+### `fetch` — one snapshot, in memory
+
+The programmatic convenience verb: one endpoint's full current listing as an
+eager, typed Polars DataFrame. No disk, no state, no configuration file.
+
+```python
+from fleetpull import Endpoints, fetch
+
+vehicles = fetch(Endpoints.Motive.vehicles, auth='your-api-key')
+devices = fetch(
+    Endpoints.Geotab.devices,
+    auth={'username': '...', 'password': '...', 'database': '...'},
+)
+```
+
+- `auth` is a bare API-key string for Motive/Samsara and named fields (a
+  mapping or `GeotabAuthConfig`) for GeoTab. Credentials are wrapped in
+  `SecretStr` at the boundary and never appear in errors or logs.
+- Behind a TLS-intercepting corporate proxy (Zscaler-class), pass
+  `use_truststore=True` to build TLS contexts from the OS trust store.
+- `fetch` exposes **snapshot endpoints only** — a snapshot is bounded by
+  entity count, so the in-memory contract stays honest. Windowed history is
+  `sync` territory, and the type checker (plus a runtime guard) enforces the
+  split.
+- An empty result is a zero-row frame carrying the full typed schema, never
+  `None`.
+
+### `Sync` — config-driven incremental pipeline
+
+The pipeline verb: a YAML config selects providers and endpoints; each run
+fetches incrementally, writes parquet, and commits its resume state.
+`fleetpull init-config` writes a documented starter config to edit.
+
+```python
+from fleetpull import Sync
+
+Sync('fleetpull_config.yaml').run()
+```
+
+```yaml
+sync:
+  default_start_date: 2025-01-01   # cold-start backfill anchor
+
+storage:
+  dataset_root: /data/fleet        # parquet lands here
+
+logging:
+  console_level: INFO
+
+providers:
+  motive:
+    endpoints: [vehicles, vehicle_locations, driving_periods]
+    # api_key: falls back to the MOTIVE_API_KEY environment variable
+  samsara:
+    endpoints: [vehicles]
+    # api_key: falls back to SAMSARA_API_KEY
+  geotab:
+    auth:
+      username: user@example.com
+      database: my_database
+      # password: falls back to GEOTAB_PASSWORD
+    endpoints: [devices, users, trips]
+    lookback_days: 7               # late-arrival refetch margin
+```
+
+The same run is available from the shell: `fleetpull sync fleetpull_config.yaml`.
+
+Endpoints run and commit independently — one endpoint's failure never halts
+its siblings; a run with failures ends by raising `SyncFailuresError`
+carrying every failure (queue order within each provider — feeders then
+consumers, config order within each — providers in config order).
+
+Output is one folder per endpoint under `dataset_root`:
+
+```
+data/
+  motive/
+    vehicles/                    # snapshot: one file, replaced each run
+      data.parquet
+      metadata.json              # human-readable run summary — never read by the program
+    driving_periods/             # windowed: hive date partitions
+      date=2026-07-15/part.parquet
+      date=2026-07-16/part.parquet
+      metadata.json
+```
+
+Hive `date=YYYY-MM-DD` layout is read natively by `pl.scan_parquet` and
+BigQuery external tables. Operational state (watermarks, run ledger, backfill
+work units) lives in SQLite at `<dataset_root>/.fleetpull/state.sqlite3`;
+crash-safety ordering (parquet first, cursor second) plus delete-by-window
+merge makes interrupted runs refetch idempotently — at-least-once fetching,
+exactly-once data.
+
+## Output contract
+
+- **One schema per (provider, endpoint).** Column dtypes derive from each
+  endpoint's Pydantic response model; nested objects flatten to
+  double-underscore-joined columns (`driver__id`). No cross-endpoint or
+  cross-provider unification, ever.
+- **Event timestamps are timezone-aware UTC** end to end.
+- **Exact-duplicate rows** (artifacts of pagination and crash refetch) are
+  dropped at write time; same-id-different-payload reconciliation belongs to
+  consumers.
+- Values arrive as the provider sent them — no unit conversion, no semantic
+  cleanup. Provider quirks worth knowing (GeoTab's seconds-despite-the-name
+  `engineHours`, sentinel dates, per-endpoint window anchoring) are recorded
+  in [ENDPOINTS.md](ENDPOINTS.md) and DESIGN §8.
+
+## Errors
+
+Consumers catch `FleetpullError` or its five public subclasses:
+
+| Exception | When | Reasonable reaction |
+|---|---|---|
+| `ConfigurationError` | Bad config or wiring | Fix config, rerun |
+| `AuthenticationError` | Rejected credentials | Fix credentials |
+| `ProviderResponseError` | Non-retryable or contract-violating response | Investigate before rerunning |
+| `RetriesExhaustedError` | Transient/rate-limit budget ran out | Rerun later |
+| `SyncFailuresError` | One or more endpoints failed inside a sync run | Inspect `failures`, act per member |
+
+Everything else is internal. Rate limits are respected automatically — a
+shared token-bucket limiter sits at the transport boundary and a 429's
+`Retry-After` pauses the whole quota scope.
+
+## Documentation
+
+- [ENDPOINTS.md](ENDPOINTS.md) — every shipped endpoint, its mechanics, and
+  the port queue.
+- [DESIGN.md](DESIGN.md) — the design of record: architecture, invariants,
+  and the probe-captured provider behaviors every binding encodes.
+- [CLAUDE.md](CLAUDE.md) — engineering standards and verification gates.
+
+## Contributing
+
+Contributions are welcome and encouraged — a new endpoint, a bug fix, a
+sharper docstring, or a provider quirk you've hit in the wild. Start with
+[CONTRIBUTING.md](CONTRIBUTING.md); the short version:
+
+```bash
+uv sync --group dev
+uv run ruff format . && uv run ruff check . \
+  && uv run mypy src/ tests/ \
+  && uv run lint-imports \
+  && uv run pytest
+```
+
+These five gates are exactly what CI runs on every pull request, so a green
+local run is a green CI run. Tests never hit real provider APIs; new
+endpoints are built probe-first from live captures — the port discipline is
+in [ENDPOINTS.md](ENDPOINTS.md), and the engineering standards are in
+[CLAUDE.md](CLAUDE.md).
+
+## Acknowledgements
+
+Built on [Polars](https://pola.rs), [Pydantic](https://pydantic.dev),
+[httpx](https://www.python-httpx.org), and
+[truststore](https://truststore.readthedocs.io) — fleetpull is a thin, rigorous
+layer over their work.
+
+## Author
+
+By Andrew Jordan. Questions, bugs, and endpoint requests are best raised as
+[GitHub issues](https://github.com/andrewjordan3/fleetpull/issues).
+
+## License
+
+[Apache License 2.0](LICENSE).

fleetpull-0.1.0/README.md

@@ -0,0 +1,210 @@
+# fleetpull
+
+fleetpull pulls fleet telematics data from provider APIs — **Motive**,
+**Samsara**, and **GeoTab** — and delivers it as typed, dtype-coerced,
+lightly normalized tabular output: Polars DataFrames in memory, parquet on
+disk, staying as close to the raw API responses as is reasonable.
+
+It is deliberately narrow. fleetpull does no cross-endpoint merging, builds
+no unified cross-provider schema, performs no semantic deduplication, loads
+no warehouse, and assumes no end use — downstream processing is the
+consumer's concern. What it does instead is be rigorous about retrieval:
+probed (never merely documented) provider behavior, crash-safe incremental
+state, token-bucket rate limiting at the transport boundary, and one
+explicit schema per (provider, endpoint).
+
+**Status:** alpha. The two public verbs below are settled, and coverage is
+broad — the Motive and Samsara endpoint inventories and the GeoTab `Get` and
+feed surfaces are all shipped (see [ENDPOINTS.md](ENDPOINTS.md)). Pre-1.0,
+the internals are still free to improve.
+
+## Install
+
+```bash
+pip install fleetpull
+# or
+uv add fleetpull
+```
+
+The latest development version, straight from source:
+
+```bash
+pip install git+https://github.com/andrewjordan3/fleetpull
+```
+
+Python ≥ 3.12. Core dependencies: `httpx`, `polars`, `pydantic` 2.x,
+`pyyaml`, `truststore`, `tzdata`.
+
+To scaffold a starter config for the `sync` verb below, run
+`fleetpull init-config` — it writes an annotated `fleetpull_config.yaml`
+you edit and point `sync` at.
+
+## The two verbs
+
+### `fetch` — one snapshot, in memory
+
+The programmatic convenience verb: one endpoint's full current listing as an
+eager, typed Polars DataFrame. No disk, no state, no configuration file.
+
+```python
+from fleetpull import Endpoints, fetch
+
+vehicles = fetch(Endpoints.Motive.vehicles, auth='your-api-key')
+devices = fetch(
+    Endpoints.Geotab.devices,
+    auth={'username': '...', 'password': '...', 'database': '...'},
+)
+```
+
+- `auth` is a bare API-key string for Motive/Samsara and named fields (a
+  mapping or `GeotabAuthConfig`) for GeoTab. Credentials are wrapped in
+  `SecretStr` at the boundary and never appear in errors or logs.
+- Behind a TLS-intercepting corporate proxy (Zscaler-class), pass
+  `use_truststore=True` to build TLS contexts from the OS trust store.
+- `fetch` exposes **snapshot endpoints only** — a snapshot is bounded by
+  entity count, so the in-memory contract stays honest. Windowed history is
+  `sync` territory, and the type checker (plus a runtime guard) enforces the
+  split.
+- An empty result is a zero-row frame carrying the full typed schema, never
+  `None`.
+
+### `Sync` — config-driven incremental pipeline
+
+The pipeline verb: a YAML config selects providers and endpoints; each run
+fetches incrementally, writes parquet, and commits its resume state.
+`fleetpull init-config` writes a documented starter config to edit.
+
+```python
+from fleetpull import Sync
+
+Sync('fleetpull_config.yaml').run()
+```
+
+```yaml
+sync:
+  default_start_date: 2025-01-01   # cold-start backfill anchor
+
+storage:
+  dataset_root: /data/fleet        # parquet lands here
+
+logging:
+  console_level: INFO
+
+providers:
+  motive:
+    endpoints: [vehicles, vehicle_locations, driving_periods]
+    # api_key: falls back to the MOTIVE_API_KEY environment variable
+  samsara:
+    endpoints: [vehicles]
+    # api_key: falls back to SAMSARA_API_KEY
+  geotab:
+    auth:
+      username: user@example.com
+      database: my_database
+      # password: falls back to GEOTAB_PASSWORD
+    endpoints: [devices, users, trips]
+    lookback_days: 7               # late-arrival refetch margin
+```
+
+The same run is available from the shell: `fleetpull sync fleetpull_config.yaml`.
+
+Endpoints run and commit independently — one endpoint's failure never halts
+its siblings; a run with failures ends by raising `SyncFailuresError`
+carrying every failure (queue order within each provider — feeders then
+consumers, config order within each — providers in config order).
+
+Output is one folder per endpoint under `dataset_root`:
+
+```
+data/
+  motive/
+    vehicles/                    # snapshot: one file, replaced each run
+      data.parquet
+      metadata.json              # human-readable run summary — never read by the program
+    driving_periods/             # windowed: hive date partitions
+      date=2026-07-15/part.parquet
+      date=2026-07-16/part.parquet
+      metadata.json
+```
+
+Hive `date=YYYY-MM-DD` layout is read natively by `pl.scan_parquet` and
+BigQuery external tables. Operational state (watermarks, run ledger, backfill
+work units) lives in SQLite at `<dataset_root>/.fleetpull/state.sqlite3`;
+crash-safety ordering (parquet first, cursor second) plus delete-by-window
+merge makes interrupted runs refetch idempotently — at-least-once fetching,
+exactly-once data.
+
+## Output contract
+
+- **One schema per (provider, endpoint).** Column dtypes derive from each
+  endpoint's Pydantic response model; nested objects flatten to
+  double-underscore-joined columns (`driver__id`). No cross-endpoint or
+  cross-provider unification, ever.
+- **Event timestamps are timezone-aware UTC** end to end.
+- **Exact-duplicate rows** (artifacts of pagination and crash refetch) are
+  dropped at write time; same-id-different-payload reconciliation belongs to
+  consumers.
+- Values arrive as the provider sent them — no unit conversion, no semantic
+  cleanup. Provider quirks worth knowing (GeoTab's seconds-despite-the-name
+  `engineHours`, sentinel dates, per-endpoint window anchoring) are recorded
+  in [ENDPOINTS.md](ENDPOINTS.md) and DESIGN §8.
+
+## Errors
+
+Consumers catch `FleetpullError` or its five public subclasses:
+
+| Exception | When | Reasonable reaction |
+|---|---|---|
+| `ConfigurationError` | Bad config or wiring | Fix config, rerun |
+| `AuthenticationError` | Rejected credentials | Fix credentials |
+| `ProviderResponseError` | Non-retryable or contract-violating response | Investigate before rerunning |
+| `RetriesExhaustedError` | Transient/rate-limit budget ran out | Rerun later |
+| `SyncFailuresError` | One or more endpoints failed inside a sync run | Inspect `failures`, act per member |
+
+Everything else is internal. Rate limits are respected automatically — a
+shared token-bucket limiter sits at the transport boundary and a 429's
+`Retry-After` pauses the whole quota scope.
+
+## Documentation
+
+- [ENDPOINTS.md](ENDPOINTS.md) — every shipped endpoint, its mechanics, and
+  the port queue.
+- [DESIGN.md](DESIGN.md) — the design of record: architecture, invariants,
+  and the probe-captured provider behaviors every binding encodes.
+- [CLAUDE.md](CLAUDE.md) — engineering standards and verification gates.
+
+## Contributing
+
+Contributions are welcome and encouraged — a new endpoint, a bug fix, a
+sharper docstring, or a provider quirk you've hit in the wild. Start with
+[CONTRIBUTING.md](CONTRIBUTING.md); the short version:
+
+```bash
+uv sync --group dev
+uv run ruff format . && uv run ruff check . \
+  && uv run mypy src/ tests/ \
+  && uv run lint-imports \
+  && uv run pytest
+```
+
+These five gates are exactly what CI runs on every pull request, so a green
+local run is a green CI run. Tests never hit real provider APIs; new
+endpoints are built probe-first from live captures — the port discipline is
+in [ENDPOINTS.md](ENDPOINTS.md), and the engineering standards are in
+[CLAUDE.md](CLAUDE.md).
+
+## Acknowledgements
+
+Built on [Polars](https://pola.rs), [Pydantic](https://pydantic.dev),
+[httpx](https://www.python-httpx.org), and
+[truststore](https://truststore.readthedocs.io) — fleetpull is a thin, rigorous
+layer over their work.
+
+## Author
+
+By Andrew Jordan. Questions, bugs, and endpoint requests are best raised as
+[GitHub issues](https://github.com/andrewjordan3/fleetpull/issues).
+
+## License
+
+[Apache License 2.0](LICENSE).