altissimo-shippo-tracking 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2024 Altissimo HQ
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
@@ -0,0 +1,169 @@
1
+ Metadata-Version: 2.4
2
+ Name: altissimo-shippo-tracking
3
+ Version: 0.2.1
4
+ Summary: Shippo shipping & tracking client with optional Firestore persistence.
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Author: Lukas Karlsson
8
+ Author-email: karlsson@altissimo.io
9
+ Requires-Python: >=3.11,<4.0
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
+ Classifier: Typing :: Typed
18
+ Provides-Extra: firestore
19
+ Requires-Dist: altissimo-firedantic (>=0.22.4,<0.23) ; extra == "firestore"
20
+ Requires-Dist: google-cloud-firestore (>=2.0) ; extra == "firestore"
21
+ Requires-Dist: pydantic (>=2.0)
22
+ Requires-Dist: requests (>=2.28)
23
+ Project-URL: Changelog, https://github.com/altissimo-hq/shippo-tracking/blob/main/CHANGELOG.md
24
+ Project-URL: Homepage, https://github.com/altissimo-hq/shippo-tracking
25
+ Project-URL: Repository, https://github.com/altissimo-hq/shippo-tracking
26
+ Description-Content-Type: text/markdown
27
+
28
+ # shippo-tracking
29
+
30
+ Shippo shipping & tracking client with optional Firestore persistence.
31
+
32
+ ## Installation
33
+
34
+ Published on PyPI as `altissimo-shippo-tracking`; the import name is
35
+ `altissimo.shippo_tracking`.
36
+
37
+ ```bash
38
+ # Basic (API client + models only)
39
+ pip install altissimo-shippo-tracking
40
+
41
+ # With Firestore persistence
42
+ pip install "altissimo-shippo-tracking[firestore]"
43
+ ```
44
+
45
+ The `firestore` extra installs [`altissimo-firedantic`](https://pypi.org/project/altissimo-firedantic/),
46
+ Altissimo's maintained fork of firedantic. It is still imported as `firedantic`, so don't
47
+ install the upstream `firedantic` package alongside it.
48
+
49
+ ## Quick Start
50
+
51
+ ```python
52
+ from altissimo.shippo_tracking import ShippoClient
53
+
54
+ client = ShippoClient() # reads SHIPPO_API_KEY from env
55
+ status = client.get_tracking_status("usps", "9400111899223456789012")
56
+ print(status.tracking_status.status) # "TRANSIT", "DELIVERED", etc.
57
+ ```
58
+
59
+ ## With Firestore Persistence
60
+
61
+ ```python
62
+ from altissimo.shippo_tracking import ShippoService
63
+
64
+ service = ShippoService()
65
+
66
+ # Fetch from API, save to Firestore, and register for webhooks if this
67
+ # tracking number hasn't been seen before
68
+ detail = service.save_tracking_detail("usps", "9400111899223456789012", register_if_new=True)
69
+
70
+ # List records, optionally filtered by status (case-insensitive)
71
+ in_flight = service.list_tracking_details(exclude_status="DELIVERED")
72
+ delivered = service.list_tracking_details(status="DELIVERED")
73
+ ```
74
+
75
+ The Shippo GET tracking endpoint does **not** subscribe a shipment to
76
+ `track_updated` webhooks — only `register_tracking()` does. Pass
77
+ `register_if_new=True` so new tracking numbers are registered automatically;
78
+ without it, saving a new tracking number logs a warning.
79
+
80
+ ## Delivery Callback Hook
81
+
82
+ Inject your own logic for when a package is delivered:
83
+
84
+ ```python
85
+ from altissimo.shippo_tracking import ShippoService, ShippoTrackingDetail
86
+
87
+ def handle_delivery(detail: ShippoTrackingDetail):
88
+ print(f"Package {detail.tracking_number} delivered!")
89
+ # Send email, update order, notify team, etc.
90
+
91
+ service = ShippoService(on_delivery=handle_delivery)
92
+ ```
93
+
94
+ ## Status Downgrade Protection
95
+
96
+ The service guards against **status regression**. Tracking statuses have a natural
97
+ lifecycle ordering:
98
+
99
+ ```text
100
+ UNKNOWN → PRE_TRANSIT → TRANSIT → DELIVERED → RETURNED → FAILURE
101
+ ```
102
+
103
+ If a persisted record already has a status further along in this progression (e.g.
104
+ `DELIVERED`), and the Shippo API or a webhook returns a lower status (e.g.
105
+ `PRE_TRANSIT` — common when USPS purges old tracking data), the update is
106
+ **silently skipped** and the existing record is preserved.
107
+
108
+ This applies to both `save_tracking_detail()` and incoming webhook events.
109
+
110
+ ## FastAPI Webhook Router
111
+
112
+ ```python
113
+ import os
114
+
115
+ from fastapi import FastAPI
116
+ from altissimo.shippo_tracking.router import create_shippo_router
117
+
118
+ app = FastAPI()
119
+
120
+ # Simple — no delivery callback
121
+ app.include_router(create_shippo_router())
122
+
123
+ # With delivery callback
124
+ app.include_router(create_shippo_router(on_delivery=handle_delivery))
125
+
126
+ # With a self-generated URL token (401 on missing/wrong ?token=)
127
+ app.include_router(create_shippo_router(webhook_token=os.environ["SHIPPO_WEBHOOK_TOKEN"]))
128
+
129
+ # With HMAC signature verification (401 on missing/invalid signature)
130
+ app.include_router(create_shippo_router(webhook_secret=os.environ["SHIPPO_WEBHOOK_SECRET"]))
131
+ ```
132
+
133
+ ### Webhook authentication
134
+
135
+ [Shippo offers three ways](https://docs.goshippo.com/tracking/webhook-security)
136
+ to secure webhooks; this router supports the two
137
+ that are checked per request, and they can be combined.
138
+
139
+ - **Self-generated token** (`webhook_token`): in the Shippo dashboard
140
+ (Settings → API → Webhooks), append `?token=<your token>` to the webhook URL.
141
+ Shippo echoes it back on every POST and the router compares it in constant time.
142
+ - **HMAC** (`webhook_secret`): requires Shippo's solutions team to provision a
143
+ secret (up to ~10 business days).
144
+ - **IP allowlist**: enforce at your load balancer/firewall; not handled here.
145
+
146
+ When `webhook_secret` is set, requests must carry a
147
+ `Shippo-Auth-Signature: t=<timestamp>,v1=<hex HMAC-SHA256(secret, "<timestamp>.<raw body>")>`
148
+ header. `signature_tolerance_seconds` optionally rejects stale timestamps.
149
+ To send signed test payloads, use
150
+ `altissimo.shippo_tracking.webhook.compute_signature_header(secret, body)`.
151
+
152
+ ## Testing
153
+
154
+ ```bash
155
+ poetry install --with dev
156
+ poetry run pytest -v
157
+ ```
158
+
159
+ All unit tests use in-memory fakes — no Firestore or network access required.
160
+
161
+ Integration tests in `tests/test_repo_integration.py` exercise `ShippoRepo`
162
+ against the Firestore emulator and are skipped unless `FIRESTORE_EMULATOR_HOST`
163
+ is set. To run them (requires the Firebase CLI and Java):
164
+
165
+ ```bash
166
+ poetry install --with dev --all-extras
167
+ firebase emulators:exec --only firestore --project demo-shippo-tracking "poetry run pytest -m integration -v"
168
+ ```
169
+
@@ -0,0 +1,141 @@
1
+ # shippo-tracking
2
+
3
+ Shippo shipping & tracking client with optional Firestore persistence.
4
+
5
+ ## Installation
6
+
7
+ Published on PyPI as `altissimo-shippo-tracking`; the import name is
8
+ `altissimo.shippo_tracking`.
9
+
10
+ ```bash
11
+ # Basic (API client + models only)
12
+ pip install altissimo-shippo-tracking
13
+
14
+ # With Firestore persistence
15
+ pip install "altissimo-shippo-tracking[firestore]"
16
+ ```
17
+
18
+ The `firestore` extra installs [`altissimo-firedantic`](https://pypi.org/project/altissimo-firedantic/),
19
+ Altissimo's maintained fork of firedantic. It is still imported as `firedantic`, so don't
20
+ install the upstream `firedantic` package alongside it.
21
+
22
+ ## Quick Start
23
+
24
+ ```python
25
+ from altissimo.shippo_tracking import ShippoClient
26
+
27
+ client = ShippoClient() # reads SHIPPO_API_KEY from env
28
+ status = client.get_tracking_status("usps", "9400111899223456789012")
29
+ print(status.tracking_status.status) # "TRANSIT", "DELIVERED", etc.
30
+ ```
31
+
32
+ ## With Firestore Persistence
33
+
34
+ ```python
35
+ from altissimo.shippo_tracking import ShippoService
36
+
37
+ service = ShippoService()
38
+
39
+ # Fetch from API, save to Firestore, and register for webhooks if this
40
+ # tracking number hasn't been seen before
41
+ detail = service.save_tracking_detail("usps", "9400111899223456789012", register_if_new=True)
42
+
43
+ # List records, optionally filtered by status (case-insensitive)
44
+ in_flight = service.list_tracking_details(exclude_status="DELIVERED")
45
+ delivered = service.list_tracking_details(status="DELIVERED")
46
+ ```
47
+
48
+ The Shippo GET tracking endpoint does **not** subscribe a shipment to
49
+ `track_updated` webhooks — only `register_tracking()` does. Pass
50
+ `register_if_new=True` so new tracking numbers are registered automatically;
51
+ without it, saving a new tracking number logs a warning.
52
+
53
+ ## Delivery Callback Hook
54
+
55
+ Inject your own logic for when a package is delivered:
56
+
57
+ ```python
58
+ from altissimo.shippo_tracking import ShippoService, ShippoTrackingDetail
59
+
60
+ def handle_delivery(detail: ShippoTrackingDetail):
61
+ print(f"Package {detail.tracking_number} delivered!")
62
+ # Send email, update order, notify team, etc.
63
+
64
+ service = ShippoService(on_delivery=handle_delivery)
65
+ ```
66
+
67
+ ## Status Downgrade Protection
68
+
69
+ The service guards against **status regression**. Tracking statuses have a natural
70
+ lifecycle ordering:
71
+
72
+ ```text
73
+ UNKNOWN → PRE_TRANSIT → TRANSIT → DELIVERED → RETURNED → FAILURE
74
+ ```
75
+
76
+ If a persisted record already has a status further along in this progression (e.g.
77
+ `DELIVERED`), and the Shippo API or a webhook returns a lower status (e.g.
78
+ `PRE_TRANSIT` — common when USPS purges old tracking data), the update is
79
+ **silently skipped** and the existing record is preserved.
80
+
81
+ This applies to both `save_tracking_detail()` and incoming webhook events.
82
+
83
+ ## FastAPI Webhook Router
84
+
85
+ ```python
86
+ import os
87
+
88
+ from fastapi import FastAPI
89
+ from altissimo.shippo_tracking.router import create_shippo_router
90
+
91
+ app = FastAPI()
92
+
93
+ # Simple — no delivery callback
94
+ app.include_router(create_shippo_router())
95
+
96
+ # With delivery callback
97
+ app.include_router(create_shippo_router(on_delivery=handle_delivery))
98
+
99
+ # With a self-generated URL token (401 on missing/wrong ?token=)
100
+ app.include_router(create_shippo_router(webhook_token=os.environ["SHIPPO_WEBHOOK_TOKEN"]))
101
+
102
+ # With HMAC signature verification (401 on missing/invalid signature)
103
+ app.include_router(create_shippo_router(webhook_secret=os.environ["SHIPPO_WEBHOOK_SECRET"]))
104
+ ```
105
+
106
+ ### Webhook authentication
107
+
108
+ [Shippo offers three ways](https://docs.goshippo.com/tracking/webhook-security)
109
+ to secure webhooks; this router supports the two
110
+ that are checked per request, and they can be combined.
111
+
112
+ - **Self-generated token** (`webhook_token`): in the Shippo dashboard
113
+ (Settings → API → Webhooks), append `?token=<your token>` to the webhook URL.
114
+ Shippo echoes it back on every POST and the router compares it in constant time.
115
+ - **HMAC** (`webhook_secret`): requires Shippo's solutions team to provision a
116
+ secret (up to ~10 business days).
117
+ - **IP allowlist**: enforce at your load balancer/firewall; not handled here.
118
+
119
+ When `webhook_secret` is set, requests must carry a
120
+ `Shippo-Auth-Signature: t=<timestamp>,v1=<hex HMAC-SHA256(secret, "<timestamp>.<raw body>")>`
121
+ header. `signature_tolerance_seconds` optionally rejects stale timestamps.
122
+ To send signed test payloads, use
123
+ `altissimo.shippo_tracking.webhook.compute_signature_header(secret, body)`.
124
+
125
+ ## Testing
126
+
127
+ ```bash
128
+ poetry install --with dev
129
+ poetry run pytest -v
130
+ ```
131
+
132
+ All unit tests use in-memory fakes — no Firestore or network access required.
133
+
134
+ Integration tests in `tests/test_repo_integration.py` exercise `ShippoRepo`
135
+ against the Firestore emulator and are skipped unless `FIRESTORE_EMULATOR_HOST`
136
+ is set. To run them (requires the Firebase CLI and Java):
137
+
138
+ ```bash
139
+ poetry install --with dev --all-extras
140
+ firebase emulators:exec --only firestore --project demo-shippo-tracking "poetry run pytest -m integration -v"
141
+ ```
@@ -0,0 +1,100 @@
1
+ [project]
2
+ name = "altissimo-shippo-tracking"
3
+ version = "0.2.1"
4
+ description = "Shippo shipping & tracking client with optional Firestore persistence."
5
+ authors = [{ name = "Lukas Karlsson", email = "karlsson@altissimo.io" }]
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ readme = "README.md"
9
+ requires-python = ">=3.11,<4.0"
10
+ classifiers = [
11
+ "Development Status :: 3 - Alpha",
12
+ "Intended Audience :: Developers",
13
+ "Programming Language :: Python :: 3",
14
+ "Programming Language :: Python :: 3.11",
15
+ "Programming Language :: Python :: 3.12",
16
+ "Programming Language :: Python :: 3.13",
17
+ "Topic :: Software Development :: Libraries :: Python Modules",
18
+ "Typing :: Typed",
19
+ ]
20
+ dependencies = [
21
+ "pydantic>=2.0",
22
+ "requests>=2.28",
23
+ ]
24
+
25
+ [project.optional-dependencies]
26
+ # pip install altissimo-shippo-tracking[firestore]
27
+ firestore = [
28
+ # The Altissimo fork of firedantic, published as altissimo-firedantic
29
+ # (import name is still `firedantic`).
30
+ "altissimo-firedantic>=0.22.4,<0.23",
31
+ "google-cloud-firestore>=2.0",
32
+ ]
33
+
34
+ [project.urls]
35
+ Homepage = "https://github.com/altissimo-hq/shippo-tracking"
36
+ Repository = "https://github.com/altissimo-hq/shippo-tracking"
37
+ Changelog = "https://github.com/altissimo-hq/shippo-tracking/blob/main/CHANGELOG.md"
38
+
39
+ [tool.poetry]
40
+ # Only Poetry-specific settings live here; package metadata is in [project].
41
+ packages = [{ include = "altissimo", from = "src" }]
42
+
43
+ [tool.poetry.group.dev.dependencies]
44
+ pytest = ">=7.0"
45
+ fastapi = ">=0.100"
46
+ httpx = ">=0.24"
47
+ mypy = ">=1.15"
48
+ types-requests = ">=2.28"
49
+ pre-commit = "^4.6.0"
50
+ pytest-cov = "^7.1.0"
51
+ ruff = "^0.15.16"
52
+
53
+ [build-system]
54
+ requires = ["poetry-core>=2.2.0,<3.0.0"]
55
+ build-backend = "poetry.core.masonry.api"
56
+
57
+ [tool.pytest.ini_options]
58
+ testpaths = ["tests"]
59
+ markers = [
60
+ "unit: Unit tests (no infrastructure)",
61
+ "integration: Integration tests (requires infrastructure)",
62
+ ]
63
+
64
+ [tool.ruff]
65
+ target-version = "py311"
66
+ line-length = 120
67
+ src = ["src", "tests"]
68
+
69
+ [tool.ruff.lint]
70
+ select = [
71
+ "E", "W", "F", "I", "N", "UP", "B", "S", "SIM", "PT", "TCH", "RUF"
72
+ ]
73
+
74
+ [tool.ruff.lint.isort]
75
+ known-first-party = ["altissimo"]
76
+
77
+ [tool.ruff.lint.per-file-ignores]
78
+ "tests/**/*.py" = ["S101", "S105", "S106", "PT011"]
79
+
80
+ [tool.coverage.run]
81
+ source = ["altissimo"]
82
+ omit = ["*/tests/*"]
83
+
84
+ [tool.coverage.report]
85
+ show_missing = true
86
+
87
+ [tool.mypy]
88
+ python_version = "3.11"
89
+ strict = true
90
+ warn_return_any = true
91
+ warn_unused_configs = true
92
+ namespace_packages = true
93
+ explicit_package_bases = true
94
+ mypy_path = "src"
95
+ plugins = ["pydantic.mypy"]
96
+ exclude = ["tests/"]
97
+
98
+ [[tool.mypy.overrides]]
99
+ module = ["firedantic.*"]
100
+ ignore_missing_imports = true
@@ -0,0 +1,45 @@
1
+ """Shippo tracking client with optional Firestore persistence.
2
+
3
+ Install with ``pip install shippo-tracking[firestore]`` to enable
4
+ Firedantic persistence models and repository.
5
+ """
6
+
7
+ from __future__ import annotations
8
+
9
+ from typing import Any
10
+
11
+ __all__ = [
12
+ "ShippoClient",
13
+ "ShippoService",
14
+ "ShippoTrackingDetail",
15
+ "ShippoTrackingEvent",
16
+ "ShippoTrackingResponse",
17
+ "ShippoTrackingStatus",
18
+ "ShippoTrackingStatusEnum",
19
+ "ShippoWebhookEvent",
20
+ ]
21
+
22
+
23
+ def __getattr__(name: str) -> Any:
24
+ """Lazy attribute access — avoids import-time side effects."""
25
+ if name == "ShippoClient":
26
+ from .client import ShippoClient
27
+
28
+ return ShippoClient
29
+ if name == "ShippoService":
30
+ from .service import ShippoService
31
+
32
+ return ShippoService
33
+ if name in {
34
+ "ShippoTrackingDetail",
35
+ "ShippoTrackingEvent",
36
+ "ShippoTrackingResponse",
37
+ "ShippoTrackingStatus",
38
+ "ShippoTrackingStatusEnum",
39
+ "ShippoWebhookEvent",
40
+ }:
41
+ from . import models
42
+
43
+ return getattr(models, name)
44
+ msg = f"module {__name__!r} has no attribute {name!r}"
45
+ raise AttributeError(msg)