cardog 2.2.0__tar.gz → 2.4.0__tar.gz

{cardog-2.2.0 → cardog-2.4.0}/CHANGELOG.md

@@ -2,11 +2,64 @@
 
 All notable changes to the Cardog Python SDK will be documented in this file.
 
-The SDK's major version tracks the API's major version. A contract change
-inside API 2.x, breaking or not, is a minor bump here and names the API
-pre-release it tracks. 3.0.0, published to PyPI on 2026-09-28, broke that
-rule and is yanked: `pip install cardog` no longer resolves to it, and a
-pin on `==3.0.0` still installs. Everything it carried is in 2.1.0.
+The SDK's version follows the API version it pins. A release that pins a
+new API date is a major, so a range like `cardog>=2.4,<3` never crosses a
+breaking API version; additive changes are minors and fixes are patches. The major
+is never below the API's path major (`/v2` → 2). The first pin, 2.4.0, was
+a minor. Before general availability a contract change inside API 2.x was
+a minor bump that named the API pre-release it tracked. 3.0.0, published
+to PyPI on 2026-09-28, broke that rule and is yanked: `pip install cardog`
+no longer resolves to it, and a pin on `==3.0.0` still installs. Everything
+it carried is in 2.1.0.
+
+## [2.4.0] - 2026-10-21
+
+Pins API `2026-10-21`, the general availability of API 2.0 (CRDG-4356).
+The response shapes are the ones 2.3.0 parses (2.0.0-rc.8), so nothing else
+changes.
+
+### Changed
+
+- `cardog.PINNED_API_VERSION` is `"2026-10-21"`, and every v2 request now
+  sends `Cardog-Version: 2026-10-21`. `KNOWN_API_VERSIONS` is
+  `("2026-10-21",)`.
+- The vendored OpenAPI document reports `info.version` `2026-10-21`.
+- A release that pins a new API date from here on is a major: the next
+  breaking API version ships as 3.0.0.
+
+## [2.3.0] - 2026-10-15
+
+Tracks API 2.0.0-rc.8. Breaking on `client.v2.specs` (CRDG-4535, CRDG-4563).
+The SDK also pins an
+API contract version (CRDG-4353); nothing on the wire changes for that until
+the API's general availability.
+
+### Changed
+
+- `SpecSheet` and `SpecSheetBuild` keep their root and gain `refs`
+  (`SpecRefs`, the same keys as the VIN identity card).
+- A value in `sections` is a `SpecValue`: `value`, `unit` on every number
+  (metric; `HP` and `IN` kept), and `stated` (`SpecStated`) with the
+  source's own number when it published another unit.
+- New `markets` (`SpecMarkets`: `us` / `ca`, each a `SpecMarket` with
+  `currency`, `pricing.msrp` as a list of `SpecPrice` (`trim`, `style`,
+  `msrp`, `source`) and `colors` as lists of `SpecColor` (`name`, `rgb`,
+  `hex`)). Markets are never merged.
+- `trim_dependent`, `trims`, `unmapped` and the per-value `source`, `region`
+  and `disagreement` are gone.
+- 2.2.x validates the old sheet on the way in and raises against rc.8;
+  2.3.0 raises against rc.7. Upgrade when rc.8 is live, not before.
+
+### Added
+
+- `cardog.PINNED_API_VERSION`: generated from the vendored OpenAPI
+  document and sent as `Cardog-Version` on every v2 request. `None` until
+  general availability, so no header is sent yet.
+- `api_version=` on `Cardog` and `AsyncCardog` to speak another version.
+- `client.last_version`: a `LastVersion(requested, latest)` read off the
+  `Cardog-Version` / `Cardog-Latest-Version` response headers.
+- A request pinned past its support window raises `CardogAPIError` with
+  `code == "version_sunset"` and the migration link in `hint`.
 
 ## [2.2.0] - 2026-09-30
 

{cardog-2.2.0 → cardog-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: cardog
-Version: 2.2.0
+Version: 2.4.0
 Summary: Python SDK for the Cardog API — Canadian VIN decode, vehicle specs, live listings, market quotes, and Transport Canada + NHTSA recalls.
 Project-URL: Homepage, https://cardog.app
 Project-URL: Documentation, https://cardog.app/docs
@@ -159,7 +159,7 @@ asyncio.run(main())
 |-------|---------|
 | `client.v2.entities` | `browse(domain, ...)` · `resolve(q, ...)` · `get_by_ref(ref)` |
 | `client.v2.vin` | `get_by_vin(vin)` · `batch(vins)` · `recalls(vin)` · `listings(vin)` · `instrument(vin)` |
-| `client.v2.specs` | `catalog()` · `sheet(ref, trim=...)` |
+| `client.v2.specs` | `catalog()` · `sheet(ref, trim=...)` · `sheet_by_build(code)` |
 | `client.v2.listings` | `search(...)` · `count(...)` · `facets(...)` · `by_vin(vin)` · `by_id(id)` |
 | `client.v2.instruments` | `search(q=..., limit=...)` · `get_by_ref(ref, window=...)` |
 | `client.v2.quotes` | `get_by_ref(ref)` · `get_many(refs)` |

{cardog-2.2.0 → cardog-2.4.0}/README.md

@@ -125,7 +125,7 @@ asyncio.run(main())
 |-------|---------|
 | `client.v2.entities` | `browse(domain, ...)` · `resolve(q, ...)` · `get_by_ref(ref)` |
 | `client.v2.vin` | `get_by_vin(vin)` · `batch(vins)` · `recalls(vin)` · `listings(vin)` · `instrument(vin)` |
-| `client.v2.specs` | `catalog()` · `sheet(ref, trim=...)` |
+| `client.v2.specs` | `catalog()` · `sheet(ref, trim=...)` · `sheet_by_build(code)` |
 | `client.v2.listings` | `search(...)` · `count(...)` · `facets(...)` · `by_vin(vin)` · `by_id(id)` |
 | `client.v2.instruments` | `search(q=..., limit=...)` · `get_by_ref(ref, window=...)` |
 | `client.v2.quotes` | `get_by_ref(ref)` · `get_many(refs)` |