python-sendparcel-inpost 0.1.1__tar.gz → 0.2.0__tar.gz

python_sendparcel_inpost-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --extra dev
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --extra dev
+      - run: uv run pytest tests/ --cov=sendparcel_inpost --cov-report=xml -v

python_sendparcel_inpost-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

python_sendparcel_inpost-0.2.0/LICENSE

@@ -0,0 +1,10 @@
+
+MIT License
+
+Copyright (c) 2025, Dominik Kozaczko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

python_sendparcel_inpost-0.2.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: python-sendparcel-inpost
+Version: 0.2.0
+Summary: InPost ShipX provider for python-sendparcel.
+Project-URL: Homepage, https://github.com/python-sendparcel/python-sendparcel-inpost
+Project-URL: Repository, https://github.com/python-sendparcel/python-sendparcel-inpost
+Project-URL: Changelog, https://github.com/python-sendparcel/python-sendparcel-inpost/blob/main/CHANGELOG.md
+Project-URL: Issue Tracker, https://github.com/python-sendparcel/python-sendparcel-inpost/issues
+Author-email: Dominik Kozaczko <dominik@kozaczko.info>
+License: MIT
+License-File: LICENSE
+Keywords: inpost,parcel,sendparcel,shipping,shipx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+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: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: anyio>=4.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: python-sendparcel>=0.1.1
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.22.0; extra == 'dev'
+Requires-Dist: ruff>=0.9.0; extra == 'dev'
+Requires-Dist: ty>=0.0.1a11; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# python-sendparcel-inpost
+
+InPost ShipX provider package for the `python-sendparcel` ecosystem.
+
+> Alpha notice: this package tracks the still-changing `python-sendparcel` core.
+
+## What it provides
+
+- `InPostLockerProvider` for locker shipments
+- `InPostCourierProvider` for courier shipments
+- `ShipXClient` for direct async ShipX API access
+- ShipX-to-sendparcel status normalization helpers
+
+## Contract
+
+This package follows the cleaned core contract:
+
+- `create_shipment(...) -> ShipmentCreateResult`
+- `create_label(...) -> LabelInfo`
+- `handle_callback(...) -> ShipmentUpdateResult`
+- `fetch_shipment_status(...) -> ShipmentUpdateResult`
+- `cancel_shipment(...) -> bool`
+
+Providers do not mutate shipment state directly. They translate ShipX responses into normalized results that the core flow applies.
+
+## Installation
+
+```bash
+uv add python-sendparcel-inpost
+```
+
+or:
+
+```bash
+pip install python-sendparcel-inpost
+```
+
+## Configuration
+
+| Key | Type | Description |
+|---|---|---|
+| `token` | `str` | ShipX API bearer token |
+| `organization_id` | `int` | ShipX organization ID |
+| `sandbox` | `bool` | Use sandbox API |
+| `base_url` | `str` | Optional API base override |
+| `timeout` | `float` | Request timeout in seconds |
+
+## Status normalization
+
+ShipX statuses are normalized to sendparcel shipment statuses.
+
+- recognized ShipX statuses produce `{"status": ...}`
+- tracking numbers are included when available
+- unknown ShipX statuses do not invent fake sendparcel statuses
+
+That means callback and polling updates can safely return only tracking data when ShipX introduces a new status the mapper does not know yet.
+
+## Labels
+
+Labels are returned as payloads.
+
+- PDF labels are returned as base64 content in `LabelInfo["content_base64"]`
+- no label URL is persisted by the core contract
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest
+uv run ruff check src tests
+uv run mypy src tests
+```

python_sendparcel_inpost-0.2.0/README.md

@@ -0,0 +1,72 @@
+# python-sendparcel-inpost
+
+InPost ShipX provider package for the `python-sendparcel` ecosystem.
+
+> Alpha notice: this package tracks the still-changing `python-sendparcel` core.
+
+## What it provides
+
+- `InPostLockerProvider` for locker shipments
+- `InPostCourierProvider` for courier shipments
+- `ShipXClient` for direct async ShipX API access
+- ShipX-to-sendparcel status normalization helpers
+
+## Contract
+
+This package follows the cleaned core contract:
+
+- `create_shipment(...) -> ShipmentCreateResult`
+- `create_label(...) -> LabelInfo`
+- `handle_callback(...) -> ShipmentUpdateResult`
+- `fetch_shipment_status(...) -> ShipmentUpdateResult`
+- `cancel_shipment(...) -> bool`
+
+Providers do not mutate shipment state directly. They translate ShipX responses into normalized results that the core flow applies.
+
+## Installation
+
+```bash
+uv add python-sendparcel-inpost
+```
+
+or:
+
+```bash
+pip install python-sendparcel-inpost
+```
+
+## Configuration
+
+| Key | Type | Description |
+|---|---|---|
+| `token` | `str` | ShipX API bearer token |
+| `organization_id` | `int` | ShipX organization ID |
+| `sandbox` | `bool` | Use sandbox API |
+| `base_url` | `str` | Optional API base override |
+| `timeout` | `float` | Request timeout in seconds |
+
+## Status normalization
+
+ShipX statuses are normalized to sendparcel shipment statuses.
+
+- recognized ShipX statuses produce `{"status": ...}`
+- tracking numbers are included when available
+- unknown ShipX statuses do not invent fake sendparcel statuses
+
+That means callback and polling updates can safely return only tracking data when ShipX introduces a new status the mapper does not know yet.
+
+## Labels
+
+Labels are returned as payloads.
+
+- PDF labels are returned as base64 content in `LabelInfo["content_base64"]`
+- no label URL is persisted by the core contract
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest
+uv run ruff check src tests
+uv run mypy src tests
+```

{python_sendparcel_inpost-0.1.1 → python_sendparcel_inpost-0.2.0}/docs/configuration.md

@@ -80,10 +80,10 @@ Both providers implement the full `BaseProvider` interface:
 |---|---|
 | `create_shipment(**kwargs)` | Create a shipment in ShipX |
 | `create_label(**kwargs)` | Download shipping label (PDF by default) |
-| `fetch_shipment_status(**kwargs)` | Poll ShipX API for current status |
+| `fetch_shipment_status(**kwargs)` | Poll ShipX API and return `ShipmentUpdateResult` |
 | `cancel_shipment(**kwargs)` | Cancel the shipment (returns `True`/`False`) |
 | `verify_callback(data, headers, **kwargs)` | Verify webhook source IP |
-| `handle_callback(data, headers, **kwargs)` | Process webhook payload |
+| `handle_callback(data, headers, **kwargs)` | Normalize webhook payload into `ShipmentUpdateResult` |
 
 ## ShipXClient
 
@@ -173,7 +173,8 @@ ShipX uses 24 internal statuses. These are mapped to 8 sendparcel statuses:
 | `RETURNED` | `returned_to_sender` |
 | `FAILED` | `rejected_by_receiver`, `undelivered`, `oversized`, `missing`, `claim_created` |
 
-Unrecognized statuses return `None` from `map_shipx_status()`.
+Unrecognized statuses return `None` from `map_shipx_status()`. Use
+`build_shipment_update()` to keep tracking data even when a status is unknown.
 
 ## Error handling
 
@@ -206,9 +207,8 @@ the `X-Forwarded-For` header (first entry). Invalid or missing IPs raise
 }
 ```
 
-The `handle_callback` method extracts the status and maps it to a sendparcel
-status using `map_shipx_status()`. The actual FSM transition is handled by
-`ShipmentFlow`.
+The `handle_callback` method normalizes ShipX payloads into
+`ShipmentUpdateResult`. The core flow applies transitions.
 
 ## Enums
 

{python_sendparcel_inpost-0.1.1 → python_sendparcel_inpost-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-sendparcel-inpost"
-version = "0.1.1"
+version = "0.2.0"
 description = "InPost ShipX provider for python-sendparcel."
 readme = "README.md"
 license = { text = "MIT" }
@@ -18,7 +18,7 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Python Modules",
   "Typing :: Typed",
 ]
-dependencies = ["python-sendparcel>=0.1.0", "httpx>=0.27.0", "anyio>=4.0"]
+dependencies = ["python-sendparcel>=0.1.1", "httpx>=0.27.0", "anyio>=4.0"]
 
 [project.optional-dependencies]
 dev = [
@@ -27,8 +27,16 @@ dev = [
   "pytest-cov>=5.0",
   "respx>=0.22.0",
   "ruff>=0.9.0",
+  "ty>=0.0.1a11",
 ]
 
+[project.urls]
+Homepage = "https://github.com/python-sendparcel/python-sendparcel-inpost"
+# Documentation = "https://python-sendparcel-inpost.readthedocs.io/"
+Repository = "https://github.com/python-sendparcel/python-sendparcel-inpost"
+Changelog = "https://github.com/python-sendparcel/python-sendparcel-inpost/blob/main/CHANGELOG.md"
+"Issue Tracker" = "https://github.com/python-sendparcel/python-sendparcel-inpost/issues"
+
 [project.entry-points."sendparcel.providers"]
 inpost_locker = "sendparcel_inpost.providers.locker:InPostLockerProvider"
 inpost_courier = "sendparcel_inpost.providers.courier:InPostCourierProvider"

{python_sendparcel_inpost-0.1.1 → python_sendparcel_inpost-0.2.0}/src/sendparcel_inpost/__init__.py

@@ -1,12 +1,14 @@
 """InPost ShipX provider for python-sendparcel."""
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 
 from sendparcel_inpost.client import ShipXClient
+from sendparcel_inpost.exceptions import CircuitBreakerError
 from sendparcel_inpost.providers.courier import InPostCourierProvider
 from sendparcel_inpost.providers.locker import InPostLockerProvider
 
 __all__ = [
+    "CircuitBreakerError",
     "InPostCourierProvider",
     "InPostLockerProvider",
     "ShipXClient",