repsapi 0.1.0__tar.gz → 0.1.2__tar.gz

repsapi-0.1.2/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to the `repsapi` PyPI package. Versions follow [Semantic Versioning](https://semver.org/);
+before 1.0, a new field or method bumps the patch (`0.1.x`) and a breaking change bumps the minor (`0.x.0`).
+
+API changes on the server side are listed at https://repsapi.pl/changelog.
+
+## 0.1.2 - 2026-10-25
+
+### Added
+
+- `QcBatch["sku_en"]` and `QcBatch["sku_pl"]`: English and Polish versions of the batch's variant name when the
+  warehouse wrote it in Chinese (`sku: "黑色 / M"` → `sku_en: "Black / M"`, `sku_pl: "Czarny / M"`). Both are
+  optional, like `sku`.
+
+### Notes
+
+- No runtime changes. Older versions keep working: they return the same JSON, their types just don't know the new fields.
+
+## 0.1.1 - 2026-10-14
+
+### Added
+
+- `ServiceName` now includes `"shipping"`. `/v1/health` reports the shipping calculator behind
+  `shipping_estimate()` and `haul()` as its own service, so `health()["services"]["shipping"]` and
+  `health()["uptime_30d"]["shipping"]` are typed.
+
+### Notes
+
+- No runtime changes. 0.1.0 keeps working: it returns the same JSON, its types just don't know `shipping`.
+
+## 0.1.0 - 2026-10-14
+
+First release.
+
+### Added
+
+- `RepsApi` (sync) and `AsyncRepsApi` (asyncio - discord.py, FastAPI) clients for Python 3.9+. One dependency: `httpx`.
+  Both work as context managers and accept your own `httpx.Client` / `httpx.AsyncClient`.
+- One method per endpoint:
+  - `tracking(num)` - `GET /v1/tracking`
+  - `qc(url)` or `qc(platform=, id=)` - `GET /v1/qc`
+  - `lookup(url, currency=, agent=)` - `GET /v1/lookup`
+  - `convert(url, agents=)` - `GET /v1/convert`
+  - `shipping_estimate(country, ...)` - `POST /v1/shipping/estimate`, by weight or straight from product links
+  - `haul(items, country, ...)` - `POST /v1/haul`
+  - `usage()` - `GET /v1/usage`
+  - `shipping_countries()`, `rates(base)`, `health(days=)`, `changelog(limit=, lang=)` - public, sent without the key
+- Typed responses (`TypedDict`, `py.typed`) for every endpoint, written from the API's own route code; passes `mypy --strict`.
+- Errors as classes: `RepsApiError` → `APIError` (`status`, `type`, `message`, `details`) → `BadRequestError`,
+  `AuthenticationError`, `PermissionDeniedError`, `NotFoundError`, `UnprocessableEntityError`, `RateLimitError`
+  (`retry_after`, `reset_at`, `limit`, `used`, `scope`), `InternalServerError`; plus `APIConnectionError` and
+  `APITimeoutError` when there is no answer. Body validation errors land in `BadRequestError` with `details["fields"]`.
+- Retries: 2 by default on network errors and 500/502/503/504 (exponential backoff with jitter), and on a short `429`
+  (honours `Retry-After` up to 60 s). A used-up daily quota raises `RateLimitError` straight away.
+- Timeouts: 60 s per attempt, 180 s for `haul()` and link-based shipping estimates.
+- `health()` returns the full report on `503` instead of raising.
+
+### Security
+
+- The key is only sent in `Authorization: Bearer`, only to endpoints that need it, never in the URL.
+- `base_url` must be `https://` (`http://` only for localhost); URLs with credentials, a query or a fragment are rejected.
+- Redirects are never followed, even with your own `httpx.Client(follow_redirects=True)`, so the key can't leak to another host.
+- `repr(api)` never shows the key.
+- Keys with whitespace or control characters are rejected up front.

{repsapi-0.1.0 → repsapi-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: repsapi
-Version: 0.1.0
+Version: 0.1.2
 Summary: Official RepsApi.pl client: parcel tracking, QC photos, product lookup, agent links and shipping estimates.
 Project-URL: Homepage, https://repsapi.pl
 Project-URL: Documentation, https://repsapi.pl/docs
@@ -151,6 +151,14 @@ except UnprocessableEntityError:
 api = RepsApi(api_key="rk_live_...", timeout=30, max_retries=3)
 ```
 
+## Changelog
+
+**0.1.2** (2026-10-25): QC batches have `sku_en` / `sku_pl` - the variant name in English and Polish when the warehouse wrote it in Chinese. No runtime changes.
+
+**0.1.1** (2026-10-14): `ServiceName` includes `"shipping"` - `health()` now reports the shipping calculator. No runtime changes.
+
+**0.1.0** (2026-10-14): first release. The full list is in `CHANGELOG.md` in the source distribution.
+
 ## Links
 
 - Documentation: https://repsapi.pl/docs

{repsapi-0.1.0 → repsapi-0.1.2}/README.md

@@ -128,6 +128,14 @@ except UnprocessableEntityError:
 api = RepsApi(api_key="rk_live_...", timeout=30, max_retries=3)
 ```
 
+## Changelog
+
+**0.1.2** (2026-10-25): QC batches have `sku_en` / `sku_pl` - the variant name in English and Polish when the warehouse wrote it in Chinese. No runtime changes.
+
+**0.1.1** (2026-10-14): `ServiceName` includes `"shipping"` - `health()` now reports the shipping calculator. No runtime changes.
+
+**0.1.0** (2026-10-14): first release. The full list is in `CHANGELOG.md` in the source distribution.
+
 ## Links
 
 - Documentation: https://repsapi.pl/docs

{repsapi-0.1.0 → repsapi-0.1.2}/pyproject.toml

@@ -34,7 +34,7 @@ path = "src/repsapi/_version.py"
 
 [tool.hatch.build.targets.sdist]
 # hatchling also copies the nearest .gitignore; the local one keeps the site's out of the package
-only-include = ["src/repsapi", "README.md", "LICENSE", "pyproject.toml"]
+only-include = ["src/repsapi", "README.md", "CHANGELOG.md", "LICENSE", "pyproject.toml"]
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/repsapi"]

repsapi-0.1.2/src/repsapi/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.2"

{repsapi-0.1.0 → repsapi-0.1.2}/src/repsapi/types.py

@@ -21,7 +21,7 @@ TrackingStage = Literal[
     "ready_for_pickup", "delivered", "delayed", "exception", "returned",
 ]
 
-ServiceName = Literal["api", "tracking", "qc", "lookup", "convert"]
+ServiceName = Literal["api", "tracking", "qc", "lookup", "convert", "shipping"]
 ServiceStatus = Literal["operational", "degraded", "down"]
 ChangeTag = Literal["new", "improved", "fixed", "removed"]
 
@@ -94,6 +94,9 @@ class _QcBatchBase(TypedDict):
 
 class QcBatch(_QcBatchBase, total=False):
     sku: str
+    # English / Polish variant name, only when ``sku`` was Chinese
+    sku_en: str
+    sku_pl: str
 
 
 class _QcResponseBase(TypedDict):

repsapi-0.1.0/src/repsapi/_version.py

@@ -1 +0,0 @@
-__version__ = "0.1.0"