fastapi-microservices-platform-sdk 0.1.1__tar.gz → 0.1.2__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.
- fastapi_microservices_platform_sdk-0.1.2/PKG-INFO +80 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/README.md +5 -1
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/pyproject.toml +4 -5
- fastapi_microservices_platform_sdk-0.1.2/src/fastapi_microservices_platform_sdk.egg-info/PKG-INFO +80 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/webhook_platform_sdk/producer.py +4 -4
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/webhook_platform_sdk/receiver.py +4 -4
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/tests/test_cli.py +6 -2
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/tests/test_endpoint_event_types.py +54 -35
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/tests/test_outbox.py +1 -3
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/tests/test_producer.py +6 -2
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/tests/test_receiver_schemes.py +9 -10
- fastapi_microservices_platform_sdk-0.1.1/PKG-INFO +0 -277
- fastapi_microservices_platform_sdk-0.1.1/src/fastapi_microservices_platform_sdk.egg-info/PKG-INFO +0 -277
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/LICENSE +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/setup.cfg +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/fastapi_microservices_platform_sdk.egg-info/SOURCES.txt +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/fastapi_microservices_platform_sdk.egg-info/dependency_links.txt +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/fastapi_microservices_platform_sdk.egg-info/entry_points.txt +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/fastapi_microservices_platform_sdk.egg-info/requires.txt +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/fastapi_microservices_platform_sdk.egg-info/top_level.txt +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/webhook_platform_sdk/__init__.py +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/webhook_platform_sdk/cli.py +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/src/webhook_platform_sdk/outbox.py +0 -0
- {fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/tests/test_receiver.py +0 -0
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fastapi-microservices-platform-sdk
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: Python SDK and CLI for FastAPI Microservices Platform event delivery
|
|
5
|
+
Author: FastAPI Microservices Platform contributors
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/AmitSinghOM/fastapi-microservices-platform
|
|
8
|
+
Project-URL: Documentation, https://github.com/AmitSinghOM/fastapi-microservices-platform/blob/main/docs/phase8-adoption.md
|
|
9
|
+
Project-URL: Issues, https://github.com/AmitSinghOM/fastapi-microservices-platform/issues
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Requires-Python: >=3.11
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: httpx==0.28.1
|
|
15
|
+
Provides-Extra: outbox
|
|
16
|
+
Requires-Dist: SQLAlchemy==2.0.36; extra == "outbox"
|
|
17
|
+
Provides-Extra: test
|
|
18
|
+
Requires-Dist: pytest==8.3.4; extra == "test"
|
|
19
|
+
Requires-Dist: SQLAlchemy==2.0.36; extra == "test"
|
|
20
|
+
Dynamic: license-file
|
|
21
|
+
|
|
22
|
+
# FastAPI Microservices Platform Python SDK
|
|
23
|
+
|
|
24
|
+
The `fastapi-microservices-platform-sdk` distribution provides a synchronous
|
|
25
|
+
producer, control-plane client, raw-byte receiver verification, a SQLAlchemy
|
|
26
|
+
transactional outbox, and `webhookctl`. Its Python import remains
|
|
27
|
+
`webhook_platform_sdk`. Python 3.11+ is required.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
python -m pip install fastapi-microservices-platform-sdk
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Releases are published to [PyPI](https://pypi.org/project/fastapi-microservices-platform-sdk/)
|
|
34
|
+
from signed `sdk-v*` tags through trusted publishing. To work on the SDK
|
|
35
|
+
itself, install from a checkout instead: `python -m pip install -e .`.
|
|
36
|
+
|
|
37
|
+
```python
|
|
38
|
+
from webhook_platform_sdk import Producer
|
|
39
|
+
|
|
40
|
+
with Producer("http://localhost:8000", "whk_...") as producer:
|
|
41
|
+
event = producer.send_event(
|
|
42
|
+
"order.created",
|
|
43
|
+
{"order_id": "42"},
|
|
44
|
+
"order-42-created",
|
|
45
|
+
)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
The producer performs no implicit HTTP retries. If the result is ambiguous,
|
|
49
|
+
retry with the same idempotency key. `ApiError` exposes only status, bounded
|
|
50
|
+
error code, and bounded `Retry-After`; it never embeds raw response content.
|
|
51
|
+
|
|
52
|
+
Receiver code must pass the exact unparsed bytes to `verify_request` or
|
|
53
|
+
`verify_and_claim`. The latter accepts a durable `claim(event_id)` implementation.
|
|
54
|
+
Reserve the ID in the same transaction as durable receiver acceptance or state
|
|
55
|
+
changes, and return 2xx for a verified duplicate.
|
|
56
|
+
|
|
57
|
+
Install `.[outbox]` for `enqueue_outbox` and `OutboxRelay`. Enqueue in the
|
|
58
|
+
application transaction; the relay claims a bounded batch, commits, sends
|
|
59
|
+
outside the transaction, and finalizes with a lease token. A crash can resend,
|
|
60
|
+
so the relay always retains the same platform idempotency key.
|
|
61
|
+
|
|
62
|
+
`webhookctl auth register` and `webhookctl auth login` prompt for passwords
|
|
63
|
+
without placing them in process arguments. Login stores the bearer token in a
|
|
64
|
+
mode-`0600` file bound to the service base URL; `WEBHOOK_PLATFORM_TOKEN` can
|
|
65
|
+
override it for ephemeral environments. Organization, project, API-key, and
|
|
66
|
+
endpoint commands cover initial setup. Producer credentials come only from
|
|
67
|
+
`WEBHOOK_PLATFORM_API_KEY`. Capture one-time API keys and endpoint secrets
|
|
68
|
+
directly into a secret manager.
|
|
69
|
+
|
|
70
|
+
Endpoints subscribe to every event unless created with an event-type filter.
|
|
71
|
+
`webhookctl endpoints create --event-type order.* --event-type user.created`
|
|
72
|
+
restricts fan-out to exact types and trailing `prefix.*` wildcards; the field
|
|
73
|
+
is omitted from the request when no filter is given, so the command also works
|
|
74
|
+
against servers that predate subscription filtering. `webhookctl endpoints
|
|
75
|
+
update` changes the URL, description, or active state, replaces the
|
|
76
|
+
subscription list with repeated `--event-type` flags, or clears it with
|
|
77
|
+
`--all-events`. The same operations are available programmatically through
|
|
78
|
+
`ManagementClient.create_endpoint(..., event_types=...)` and
|
|
79
|
+
`ManagementClient.update_endpoint`, where passing `event_types=None`
|
|
80
|
+
explicitly clears the filter.
|
{fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/README.md
RENAMED
|
@@ -6,9 +6,13 @@ transactional outbox, and `webhookctl`. Its Python import remains
|
|
|
6
6
|
`webhook_platform_sdk`. Python 3.11+ is required.
|
|
7
7
|
|
|
8
8
|
```bash
|
|
9
|
-
python -m pip install
|
|
9
|
+
python -m pip install fastapi-microservices-platform-sdk
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
+
Releases are published to [PyPI](https://pypi.org/project/fastapi-microservices-platform-sdk/)
|
|
13
|
+
from signed `sdk-v*` tags through trusted publishing. To work on the SDK
|
|
14
|
+
itself, install from a checkout instead: `python -m pip install -e .`.
|
|
15
|
+
|
|
12
16
|
```python
|
|
13
17
|
from webhook_platform_sdk import Producer
|
|
14
18
|
|
{fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/pyproject.toml
RENAMED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
[build-system]
|
|
2
|
-
requires = ["setuptools==
|
|
2
|
+
requires = ["setuptools==84.0.0", "wheel==0.45.1"]
|
|
3
3
|
build-backend = "setuptools.build_meta"
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "fastapi-microservices-platform-sdk"
|
|
7
|
-
version = "0.1.
|
|
7
|
+
version = "0.1.2"
|
|
8
8
|
description = "Python SDK and CLI for FastAPI Microservices Platform event delivery"
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
requires-python = ">=3.11"
|
|
11
|
-
license =
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
12
13
|
authors = [{name = "FastAPI Microservices Platform contributors"}]
|
|
13
14
|
dependencies = ["httpx==0.28.1"]
|
|
14
15
|
classifiers = [
|
|
15
16
|
"Programming Language :: Python :: 3",
|
|
16
|
-
"License :: OSI Approved :: Apache Software License",
|
|
17
17
|
]
|
|
18
18
|
|
|
19
19
|
[project.urls]
|
|
@@ -30,7 +30,6 @@ webhookctl = "webhook_platform_sdk.cli:main"
|
|
|
30
30
|
|
|
31
31
|
[tool.setuptools]
|
|
32
32
|
package-dir = {"" = "src"}
|
|
33
|
-
license-files = ["LICENSE"]
|
|
34
33
|
|
|
35
34
|
[tool.setuptools.packages.find]
|
|
36
35
|
where = ["src"]
|
fastapi_microservices_platform_sdk-0.1.2/src/fastapi_microservices_platform_sdk.egg-info/PKG-INFO
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fastapi-microservices-platform-sdk
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: Python SDK and CLI for FastAPI Microservices Platform event delivery
|
|
5
|
+
Author: FastAPI Microservices Platform contributors
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/AmitSinghOM/fastapi-microservices-platform
|
|
8
|
+
Project-URL: Documentation, https://github.com/AmitSinghOM/fastapi-microservices-platform/blob/main/docs/phase8-adoption.md
|
|
9
|
+
Project-URL: Issues, https://github.com/AmitSinghOM/fastapi-microservices-platform/issues
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Requires-Python: >=3.11
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: httpx==0.28.1
|
|
15
|
+
Provides-Extra: outbox
|
|
16
|
+
Requires-Dist: SQLAlchemy==2.0.36; extra == "outbox"
|
|
17
|
+
Provides-Extra: test
|
|
18
|
+
Requires-Dist: pytest==8.3.4; extra == "test"
|
|
19
|
+
Requires-Dist: SQLAlchemy==2.0.36; extra == "test"
|
|
20
|
+
Dynamic: license-file
|
|
21
|
+
|
|
22
|
+
# FastAPI Microservices Platform Python SDK
|
|
23
|
+
|
|
24
|
+
The `fastapi-microservices-platform-sdk` distribution provides a synchronous
|
|
25
|
+
producer, control-plane client, raw-byte receiver verification, a SQLAlchemy
|
|
26
|
+
transactional outbox, and `webhookctl`. Its Python import remains
|
|
27
|
+
`webhook_platform_sdk`. Python 3.11+ is required.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
python -m pip install fastapi-microservices-platform-sdk
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Releases are published to [PyPI](https://pypi.org/project/fastapi-microservices-platform-sdk/)
|
|
34
|
+
from signed `sdk-v*` tags through trusted publishing. To work on the SDK
|
|
35
|
+
itself, install from a checkout instead: `python -m pip install -e .`.
|
|
36
|
+
|
|
37
|
+
```python
|
|
38
|
+
from webhook_platform_sdk import Producer
|
|
39
|
+
|
|
40
|
+
with Producer("http://localhost:8000", "whk_...") as producer:
|
|
41
|
+
event = producer.send_event(
|
|
42
|
+
"order.created",
|
|
43
|
+
{"order_id": "42"},
|
|
44
|
+
"order-42-created",
|
|
45
|
+
)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
The producer performs no implicit HTTP retries. If the result is ambiguous,
|
|
49
|
+
retry with the same idempotency key. `ApiError` exposes only status, bounded
|
|
50
|
+
error code, and bounded `Retry-After`; it never embeds raw response content.
|
|
51
|
+
|
|
52
|
+
Receiver code must pass the exact unparsed bytes to `verify_request` or
|
|
53
|
+
`verify_and_claim`. The latter accepts a durable `claim(event_id)` implementation.
|
|
54
|
+
Reserve the ID in the same transaction as durable receiver acceptance or state
|
|
55
|
+
changes, and return 2xx for a verified duplicate.
|
|
56
|
+
|
|
57
|
+
Install `.[outbox]` for `enqueue_outbox` and `OutboxRelay`. Enqueue in the
|
|
58
|
+
application transaction; the relay claims a bounded batch, commits, sends
|
|
59
|
+
outside the transaction, and finalizes with a lease token. A crash can resend,
|
|
60
|
+
so the relay always retains the same platform idempotency key.
|
|
61
|
+
|
|
62
|
+
`webhookctl auth register` and `webhookctl auth login` prompt for passwords
|
|
63
|
+
without placing them in process arguments. Login stores the bearer token in a
|
|
64
|
+
mode-`0600` file bound to the service base URL; `WEBHOOK_PLATFORM_TOKEN` can
|
|
65
|
+
override it for ephemeral environments. Organization, project, API-key, and
|
|
66
|
+
endpoint commands cover initial setup. Producer credentials come only from
|
|
67
|
+
`WEBHOOK_PLATFORM_API_KEY`. Capture one-time API keys and endpoint secrets
|
|
68
|
+
directly into a secret manager.
|
|
69
|
+
|
|
70
|
+
Endpoints subscribe to every event unless created with an event-type filter.
|
|
71
|
+
`webhookctl endpoints create --event-type order.* --event-type user.created`
|
|
72
|
+
restricts fan-out to exact types and trailing `prefix.*` wildcards; the field
|
|
73
|
+
is omitted from the request when no filter is given, so the command also works
|
|
74
|
+
against servers that predate subscription filtering. `webhookctl endpoints
|
|
75
|
+
update` changes the URL, description, or active state, replaces the
|
|
76
|
+
subscription list with repeated `--event-type` flags, or clears it with
|
|
77
|
+
`--all-events`. The same operations are available programmatically through
|
|
78
|
+
`ManagementClient.create_endpoint(..., event_types=...)` and
|
|
79
|
+
`ManagementClient.update_endpoint`, where passing `event_types=None`
|
|
80
|
+
explicitly clears the filter.
|
|
@@ -138,9 +138,7 @@ class AuthClient(_JsonClient):
|
|
|
138
138
|
client=client,
|
|
139
139
|
)
|
|
140
140
|
|
|
141
|
-
def register(
|
|
142
|
-
self, email: str, name: str, password: str
|
|
143
|
-
) -> dict[str, Any]:
|
|
141
|
+
def register(self, email: str, name: str, password: str) -> dict[str, Any]:
|
|
144
142
|
result = self._request(
|
|
145
143
|
"POST",
|
|
146
144
|
"/users/",
|
|
@@ -156,7 +154,9 @@ class AuthClient(_JsonClient):
|
|
|
156
154
|
"/auth/login",
|
|
157
155
|
data={"username": email, "password": password},
|
|
158
156
|
)
|
|
159
|
-
token =
|
|
157
|
+
token = (
|
|
158
|
+
result.get("access_token") if isinstance(result, dict) else None
|
|
159
|
+
)
|
|
160
160
|
if not isinstance(token, str) or not token:
|
|
161
161
|
raise ApiError(200, "INVALID_RESPONSE")
|
|
162
162
|
return token
|
|
@@ -127,9 +127,7 @@ def _secret_key_bytes(secret: str) -> bytes | None:
|
|
|
127
127
|
|
|
128
128
|
|
|
129
129
|
def _header_has_legacy_token(header: str) -> bool:
|
|
130
|
-
return any(
|
|
131
|
-
"=" in token.partition(",")[0] for token in header.split()
|
|
132
|
-
)
|
|
130
|
+
return any("=" in token.partition(",")[0] for token in header.split())
|
|
133
131
|
|
|
134
132
|
|
|
135
133
|
def verify_signature(
|
|
@@ -238,7 +236,9 @@ def verify_request(
|
|
|
238
236
|
try:
|
|
239
237
|
document = json.loads(raw_body)
|
|
240
238
|
except (UnicodeDecodeError, json.JSONDecodeError) as exc:
|
|
241
|
-
raise ReceiverVerificationError(
|
|
239
|
+
raise ReceiverVerificationError(
|
|
240
|
+
"Webhook body is not valid JSON"
|
|
241
|
+
) from exc
|
|
242
242
|
if not isinstance(document, dict):
|
|
243
243
|
raise ReceiverVerificationError("Webhook body must be a JSON object")
|
|
244
244
|
if document.get("id") != event_id or document.get("type") != event_type:
|
|
@@ -22,7 +22,9 @@ class FakeProducer:
|
|
|
22
22
|
return {"public_id": "event-1"}
|
|
23
23
|
|
|
24
24
|
|
|
25
|
-
def test_event_command_reads_payload_file(
|
|
25
|
+
def test_event_command_reads_payload_file(
|
|
26
|
+
monkeypatch, tmp_path, capsys
|
|
27
|
+
) -> None:
|
|
26
28
|
payload = tmp_path / "payload.json"
|
|
27
29
|
payload.write_text('{"order_id":"42"}', encoding="utf-8")
|
|
28
30
|
monkeypatch.setattr(cli, "_producer", lambda base_url: FakeProducer())
|
|
@@ -158,7 +160,9 @@ class FakeManagementClient:
|
|
|
158
160
|
return {"public_id": api_key_id, "revoked_at": "now"}
|
|
159
161
|
|
|
160
162
|
|
|
161
|
-
def test_organization_and_api_key_commands_dispatch(
|
|
163
|
+
def test_organization_and_api_key_commands_dispatch(
|
|
164
|
+
monkeypatch, capsys
|
|
165
|
+
) -> None:
|
|
162
166
|
management = FakeManagementClient()
|
|
163
167
|
monkeypatch.setattr(cli, "_management", lambda base_url: management)
|
|
164
168
|
|
|
@@ -57,15 +57,11 @@ def test_update_endpoint_sends_only_passed_fields() -> None:
|
|
|
57
57
|
return httpx.Response(200, json={"public_id": "ep-1"})
|
|
58
58
|
|
|
59
59
|
management = _management(handler)
|
|
60
|
-
management.update_endpoint(
|
|
61
|
-
"proj-1", "ep-1", event_types=["invoice.paid"]
|
|
62
|
-
)
|
|
60
|
+
management.update_endpoint("proj-1", "ep-1", event_types=["invoice.paid"])
|
|
63
61
|
|
|
64
62
|
assert requests[0].method == "PATCH"
|
|
65
63
|
assert requests[0].url.path == "/v1/projects/proj-1/endpoints/ep-1"
|
|
66
|
-
assert json.loads(requests[0].content) == {
|
|
67
|
-
"event_types": ["invoice.paid"]
|
|
68
|
-
}
|
|
64
|
+
assert json.loads(requests[0].content) == {"event_types": ["invoice.paid"]}
|
|
69
65
|
|
|
70
66
|
|
|
71
67
|
def test_update_endpoint_explicit_none_clears_filter() -> None:
|
|
@@ -82,9 +78,7 @@ def test_update_endpoint_explicit_none_clears_filter() -> None:
|
|
|
82
78
|
|
|
83
79
|
|
|
84
80
|
def test_update_endpoint_requires_a_change() -> None:
|
|
85
|
-
management = _management(
|
|
86
|
-
lambda request: httpx.Response(200, json={})
|
|
87
|
-
)
|
|
81
|
+
management = _management(lambda request: httpx.Response(200, json={}))
|
|
88
82
|
with pytest.raises(ValueError):
|
|
89
83
|
management.update_endpoint("proj-1", "ep-1")
|
|
90
84
|
|
|
@@ -100,8 +94,13 @@ class FakeManagement:
|
|
|
100
94
|
return None
|
|
101
95
|
|
|
102
96
|
def create_endpoint(
|
|
103
|
-
self,
|
|
104
|
-
|
|
97
|
+
self,
|
|
98
|
+
project_id,
|
|
99
|
+
url,
|
|
100
|
+
description,
|
|
101
|
+
*,
|
|
102
|
+
event_types,
|
|
103
|
+
signature_scheme=None,
|
|
105
104
|
):
|
|
106
105
|
self.calls.append(
|
|
107
106
|
("create", project_id, url, description, event_types)
|
|
@@ -119,21 +118,32 @@ def test_cli_create_with_repeatable_event_type(monkeypatch, capsys) -> None:
|
|
|
119
118
|
|
|
120
119
|
exit_code = cli.main(
|
|
121
120
|
[
|
|
122
|
-
"endpoints",
|
|
123
|
-
"
|
|
124
|
-
"--
|
|
125
|
-
"
|
|
126
|
-
"--
|
|
121
|
+
"endpoints",
|
|
122
|
+
"create",
|
|
123
|
+
"--project",
|
|
124
|
+
"proj-1",
|
|
125
|
+
"--url",
|
|
126
|
+
"https://receiver.example/hook",
|
|
127
|
+
"--event-type",
|
|
128
|
+
"order.*",
|
|
129
|
+
"--event-type",
|
|
130
|
+
"user.created",
|
|
127
131
|
]
|
|
128
132
|
)
|
|
129
133
|
|
|
130
134
|
assert exit_code == 0
|
|
131
|
-
assert fake.calls == [
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
+
assert fake.calls == [
|
|
136
|
+
(
|
|
137
|
+
"create",
|
|
138
|
+
"proj-1",
|
|
139
|
+
"https://receiver.example/hook",
|
|
140
|
+
None,
|
|
141
|
+
["order.*", "user.created"],
|
|
142
|
+
)
|
|
143
|
+
]
|
|
135
144
|
assert json.loads(capsys.readouterr().out)["event_types"] == [
|
|
136
|
-
"order.*",
|
|
145
|
+
"order.*",
|
|
146
|
+
"user.created",
|
|
137
147
|
]
|
|
138
148
|
|
|
139
149
|
|
|
@@ -143,10 +153,14 @@ def test_cli_update_replaces_filter(monkeypatch, capsys) -> None:
|
|
|
143
153
|
|
|
144
154
|
exit_code = cli.main(
|
|
145
155
|
[
|
|
146
|
-
"endpoints",
|
|
147
|
-
"
|
|
148
|
-
"--
|
|
149
|
-
"
|
|
156
|
+
"endpoints",
|
|
157
|
+
"update",
|
|
158
|
+
"--project",
|
|
159
|
+
"proj-1",
|
|
160
|
+
"--endpoint",
|
|
161
|
+
"ep-1",
|
|
162
|
+
"--event-type",
|
|
163
|
+
"invoice.paid",
|
|
150
164
|
]
|
|
151
165
|
)
|
|
152
166
|
|
|
@@ -162,17 +176,18 @@ def test_cli_update_all_events_clears_filter(monkeypatch) -> None:
|
|
|
162
176
|
|
|
163
177
|
exit_code = cli.main(
|
|
164
178
|
[
|
|
165
|
-
"endpoints",
|
|
166
|
-
"
|
|
167
|
-
"--
|
|
179
|
+
"endpoints",
|
|
180
|
+
"update",
|
|
181
|
+
"--project",
|
|
182
|
+
"proj-1",
|
|
183
|
+
"--endpoint",
|
|
184
|
+
"ep-1",
|
|
168
185
|
"--all-events",
|
|
169
186
|
]
|
|
170
187
|
)
|
|
171
188
|
|
|
172
189
|
assert exit_code == 0
|
|
173
|
-
assert fake.calls == [
|
|
174
|
-
("update", "proj-1", "ep-1", {"event_types": None})
|
|
175
|
-
]
|
|
190
|
+
assert fake.calls == [("update", "proj-1", "ep-1", {"event_types": None})]
|
|
176
191
|
|
|
177
192
|
|
|
178
193
|
def test_cli_update_without_changes_errors(monkeypatch, capsys) -> None:
|
|
@@ -192,10 +207,14 @@ def test_cli_update_rejects_filter_conflict(monkeypatch, capsys) -> None:
|
|
|
192
207
|
with pytest.raises(SystemExit) as excinfo:
|
|
193
208
|
cli.main(
|
|
194
209
|
[
|
|
195
|
-
"endpoints",
|
|
196
|
-
"
|
|
197
|
-
"--
|
|
198
|
-
"
|
|
210
|
+
"endpoints",
|
|
211
|
+
"update",
|
|
212
|
+
"--project",
|
|
213
|
+
"proj-1",
|
|
214
|
+
"--endpoint",
|
|
215
|
+
"ep-1",
|
|
216
|
+
"--event-type",
|
|
217
|
+
"a.b",
|
|
199
218
|
"--all-events",
|
|
200
219
|
]
|
|
201
220
|
)
|
|
@@ -47,9 +47,7 @@ def test_outbox_uses_caller_transaction_and_stable_retry_key() -> None:
|
|
|
47
47
|
row = session.execute(select(outbox_events)).mappings().one()
|
|
48
48
|
assert row["sent_at"] is not None
|
|
49
49
|
assert row["attempt_count"] == 2
|
|
50
|
-
count = session.scalar(
|
|
51
|
-
select(func.count()).select_from(outbox_events)
|
|
52
|
-
)
|
|
50
|
+
count = session.scalar(select(func.count()).select_from(outbox_events))
|
|
53
51
|
assert count == 1
|
|
54
52
|
|
|
55
53
|
|
|
@@ -24,7 +24,9 @@ def test_producer_sends_one_request_with_stable_idempotency() -> None:
|
|
|
24
24
|
client = httpx.Client(
|
|
25
25
|
transport=httpx.MockTransport(handler), base_url="https://api.example"
|
|
26
26
|
)
|
|
27
|
-
producer = Producer(
|
|
27
|
+
producer = Producer(
|
|
28
|
+
"https://ignored.example", "producer-key", client=client
|
|
29
|
+
)
|
|
28
30
|
result = producer.send_event(
|
|
29
31
|
"order.created",
|
|
30
32
|
{"order_id": "42"},
|
|
@@ -47,7 +49,9 @@ def test_api_error_does_not_expose_response_body() -> None:
|
|
|
47
49
|
),
|
|
48
50
|
base_url="https://api.example",
|
|
49
51
|
)
|
|
50
|
-
producer = Producer(
|
|
52
|
+
producer = Producer(
|
|
53
|
+
"https://ignored.example", "producer-key", client=client
|
|
54
|
+
)
|
|
51
55
|
|
|
52
56
|
with pytest.raises(ApiError) as captured:
|
|
53
57
|
producer.send_event("order.created", {}, "order-42")
|
|
@@ -99,16 +99,13 @@ def test_unknown_tokens_are_ignored_not_fatal():
|
|
|
99
99
|
now = int(time.time())
|
|
100
100
|
headers = _standard_headers(now)
|
|
101
101
|
headers["webhook-signature"] = (
|
|
102
|
-
"v1a,AAAA unknown "
|
|
103
|
-
+ headers["webhook-signature"]
|
|
102
|
+
"v1a,AAAA unknown " + headers["webhook-signature"]
|
|
104
103
|
)
|
|
105
104
|
event = verify_request(BODY, headers, STANDARD_SECRET, now=now)
|
|
106
105
|
assert event.event_id == "ev-1"
|
|
107
106
|
|
|
108
107
|
legacy = _legacy_headers(now)
|
|
109
|
-
legacy["Webhook-Signature"] =
|
|
110
|
-
legacy["Webhook-Signature"] + " v1,AAAA"
|
|
111
|
-
)
|
|
108
|
+
legacy["Webhook-Signature"] = legacy["Webhook-Signature"] + " v1,AAAA"
|
|
112
109
|
event = verify_request(BODY, legacy, LEGACY_SECRET, now=now)
|
|
113
110
|
assert event.event_id == "ev-1"
|
|
114
111
|
|
|
@@ -129,8 +126,12 @@ def test_standard_only_signature_functions():
|
|
|
129
126
|
verify_signature(BODY, headers["webhook-signature"], LEGACY_SECRET)
|
|
130
127
|
with pytest.raises(InvalidSignature):
|
|
131
128
|
verify_signature_standard(
|
|
132
|
-
BODY,
|
|
133
|
-
|
|
129
|
+
BODY,
|
|
130
|
+
"ev-1",
|
|
131
|
+
"not-digits",
|
|
132
|
+
headers["webhook-signature"],
|
|
133
|
+
STANDARD_SECRET,
|
|
134
|
+
now=now,
|
|
134
135
|
)
|
|
135
136
|
|
|
136
137
|
|
|
@@ -187,9 +188,7 @@ def test_non_ascii_signature_token_fails_closed_not_typeerror():
|
|
|
187
188
|
raised TypeError (a 500 for receivers) instead of InvalidSignature."""
|
|
188
189
|
now = int(time.time())
|
|
189
190
|
headers = _standard_headers(now)
|
|
190
|
-
only_bad = dict(
|
|
191
|
-
headers, **{"webhook-signature": "v1,签名不对"}
|
|
192
|
-
)
|
|
191
|
+
only_bad = dict(headers, **{"webhook-signature": "v1,签名不对"})
|
|
193
192
|
with pytest.raises(InvalidSignature):
|
|
194
193
|
verify_request(BODY, only_bad, STANDARD_SECRET, now=now)
|
|
195
194
|
# A non-ASCII token alongside a valid one is ignored, not fatal.
|
|
@@ -1,277 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: fastapi-microservices-platform-sdk
|
|
3
|
-
Version: 0.1.1
|
|
4
|
-
Summary: Python SDK and CLI for FastAPI Microservices Platform event delivery
|
|
5
|
-
Author: FastAPI Microservices Platform contributors
|
|
6
|
-
License: Apache License
|
|
7
|
-
Version 2.0, January 2004
|
|
8
|
-
http://www.apache.org/licenses/
|
|
9
|
-
|
|
10
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
11
|
-
|
|
12
|
-
1. Definitions.
|
|
13
|
-
|
|
14
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
15
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
16
|
-
|
|
17
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
18
|
-
the copyright owner that is granting the License.
|
|
19
|
-
|
|
20
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
21
|
-
other entities that control, are controlled by, or are under common
|
|
22
|
-
control with that entity. For the purposes of this definition,
|
|
23
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
24
|
-
direction or management of such entity, whether by contract or
|
|
25
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
26
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
27
|
-
|
|
28
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
29
|
-
exercising permissions granted by this License.
|
|
30
|
-
|
|
31
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
32
|
-
including but not limited to software source code, documentation
|
|
33
|
-
source, and configuration files.
|
|
34
|
-
|
|
35
|
-
"Object" form shall mean any form resulting from mechanical
|
|
36
|
-
transformation or translation of a Source form, including but
|
|
37
|
-
not limited to compiled object code, generated documentation,
|
|
38
|
-
and conversions to other media types.
|
|
39
|
-
|
|
40
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
41
|
-
Object form, made available under the License, as indicated by a
|
|
42
|
-
copyright notice that is included in or attached to the work
|
|
43
|
-
(an example is provided in the Appendix below).
|
|
44
|
-
|
|
45
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
46
|
-
form, that is based on (or derived from) the Work and for which the
|
|
47
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
48
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
49
|
-
of this License, Derivative Works shall not include works that remain
|
|
50
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
51
|
-
the Work and Derivative Works thereof.
|
|
52
|
-
|
|
53
|
-
"Contribution" shall mean any work of authorship, including
|
|
54
|
-
the original version of the Work and any modifications or additions
|
|
55
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
56
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
57
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
58
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
59
|
-
means any form of electronic, verbal, or written communication sent
|
|
60
|
-
to the Licensor or its representatives, including but not limited to
|
|
61
|
-
communication on electronic mailing lists, source code control systems,
|
|
62
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
63
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
64
|
-
excluding communication that is conspicuously marked or otherwise
|
|
65
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
66
|
-
|
|
67
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
68
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
69
|
-
subsequently incorporated within the Work.
|
|
70
|
-
|
|
71
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
72
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
73
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
74
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
75
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
76
|
-
Work and such Derivative Works in Source or Object form.
|
|
77
|
-
|
|
78
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
79
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
80
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
81
|
-
(except as stated in this section) patent license to make, have made,
|
|
82
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
83
|
-
where such license applies only to those patent claims licensable
|
|
84
|
-
by such Contributor that are necessarily infringed by their
|
|
85
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
86
|
-
with the Work to which such Contribution(s) was submitted.
|
|
87
|
-
If You institute patent litigation against any entity (including a
|
|
88
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
89
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
90
|
-
or contributory patent infringement, then any patent licenses
|
|
91
|
-
granted to You under this License for that Work shall terminate
|
|
92
|
-
as of the date such litigation is filed.
|
|
93
|
-
|
|
94
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
95
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
96
|
-
modifications, and in Source or Object form, provided that You
|
|
97
|
-
meet the following conditions:
|
|
98
|
-
|
|
99
|
-
(a) You must give any other recipients of the Work or
|
|
100
|
-
Derivative Works a copy of this License; and
|
|
101
|
-
|
|
102
|
-
(b) You must cause any modified files to carry prominent notices
|
|
103
|
-
stating that You changed the files; and
|
|
104
|
-
|
|
105
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
106
|
-
that You distribute, all copyright, patent, trademark, and
|
|
107
|
-
attribution notices from the Source form of the Work,
|
|
108
|
-
excluding those notices that do not pertain to any part of
|
|
109
|
-
the Derivative Works; and
|
|
110
|
-
|
|
111
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
112
|
-
distribution, then any Derivative Works that You distribute must
|
|
113
|
-
include a readable copy of the attribution notices contained
|
|
114
|
-
within such NOTICE file, excluding those notices that do not
|
|
115
|
-
pertain to any part of the Derivative Works, in at least one
|
|
116
|
-
of the following places: within a NOTICE text file distributed
|
|
117
|
-
as part of the Derivative Works; within the Source form or
|
|
118
|
-
documentation, if provided along with the Derivative Works; or,
|
|
119
|
-
within a display generated by the Derivative Works, if and
|
|
120
|
-
wherever such third-party notices normally appear. The contents
|
|
121
|
-
of the NOTICE file are for informational purposes only and
|
|
122
|
-
do not modify the License. You may add Your own attribution
|
|
123
|
-
notices within Derivative Works that You distribute, alongside
|
|
124
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
125
|
-
that such additional attribution notices cannot be construed
|
|
126
|
-
as modifying the License.
|
|
127
|
-
|
|
128
|
-
You may add Your own copyright statement to Your modifications and
|
|
129
|
-
may provide additional or different license terms and conditions
|
|
130
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
131
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
132
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
133
|
-
the conditions stated in this License.
|
|
134
|
-
|
|
135
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
136
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
137
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
138
|
-
this License, without any additional terms or conditions.
|
|
139
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
140
|
-
the terms of any separate license agreement you may have executed
|
|
141
|
-
with Licensor regarding such Contributions.
|
|
142
|
-
|
|
143
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
144
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
145
|
-
except as required for reasonable and customary use in describing the
|
|
146
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
147
|
-
|
|
148
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
149
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
150
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
151
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
152
|
-
implied, including, without limitation, any warranties or conditions
|
|
153
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
154
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
155
|
-
appropriateness of using or redistributing the Work and assume any
|
|
156
|
-
risks associated with Your exercise of permissions under this License.
|
|
157
|
-
|
|
158
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
159
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
160
|
-
unless required by applicable law (such as deliberate and grossly
|
|
161
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
162
|
-
liable to You for damages, including any direct, indirect, special,
|
|
163
|
-
incidental, or consequential damages of any character arising as a
|
|
164
|
-
result of this License or out of the use or inability to use the
|
|
165
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
166
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
167
|
-
other commercial damages or losses), even if such Contributor
|
|
168
|
-
has been advised of the possibility of such damages.
|
|
169
|
-
|
|
170
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
171
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
172
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
173
|
-
or other liability obligations and/or rights consistent with this
|
|
174
|
-
License. However, in accepting such obligations, You may act only
|
|
175
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
176
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
177
|
-
defend, and hold each Contributor harmless for any liability
|
|
178
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
179
|
-
of your accepting any such warranty or additional liability.
|
|
180
|
-
|
|
181
|
-
END OF TERMS AND CONDITIONS
|
|
182
|
-
|
|
183
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
184
|
-
|
|
185
|
-
To apply the Apache License to your work, attach the following
|
|
186
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
187
|
-
replaced with your own identifying information. (Don't include
|
|
188
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
189
|
-
comment syntax for the file format. We also recommend that a
|
|
190
|
-
file or class name and description of purpose be included on the
|
|
191
|
-
same "printed page" as the copyright notice for easier
|
|
192
|
-
identification within third-party archives.
|
|
193
|
-
|
|
194
|
-
Copyright 2026 Amit Singh
|
|
195
|
-
|
|
196
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
197
|
-
you may not use this file except in compliance with the License.
|
|
198
|
-
You may obtain a copy of the License at
|
|
199
|
-
|
|
200
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
201
|
-
|
|
202
|
-
Unless required by applicable law or agreed to in writing, software
|
|
203
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
204
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
205
|
-
See the License for the specific language governing permissions and
|
|
206
|
-
limitations under the License.
|
|
207
|
-
|
|
208
|
-
Project-URL: Repository, https://github.com/AmitSinghOM/fastapi-microservices-platform
|
|
209
|
-
Project-URL: Documentation, https://github.com/AmitSinghOM/fastapi-microservices-platform/blob/main/docs/phase8-adoption.md
|
|
210
|
-
Project-URL: Issues, https://github.com/AmitSinghOM/fastapi-microservices-platform/issues
|
|
211
|
-
Classifier: Programming Language :: Python :: 3
|
|
212
|
-
Classifier: License :: OSI Approved :: Apache Software License
|
|
213
|
-
Requires-Python: >=3.11
|
|
214
|
-
Description-Content-Type: text/markdown
|
|
215
|
-
License-File: LICENSE
|
|
216
|
-
Requires-Dist: httpx==0.28.1
|
|
217
|
-
Provides-Extra: outbox
|
|
218
|
-
Requires-Dist: SQLAlchemy==2.0.36; extra == "outbox"
|
|
219
|
-
Provides-Extra: test
|
|
220
|
-
Requires-Dist: pytest==8.3.4; extra == "test"
|
|
221
|
-
Requires-Dist: SQLAlchemy==2.0.36; extra == "test"
|
|
222
|
-
|
|
223
|
-
# FastAPI Microservices Platform Python SDK
|
|
224
|
-
|
|
225
|
-
The `fastapi-microservices-platform-sdk` distribution provides a synchronous
|
|
226
|
-
producer, control-plane client, raw-byte receiver verification, a SQLAlchemy
|
|
227
|
-
transactional outbox, and `webhookctl`. Its Python import remains
|
|
228
|
-
`webhook_platform_sdk`. Python 3.11+ is required.
|
|
229
|
-
|
|
230
|
-
```bash
|
|
231
|
-
python -m pip install .
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
```python
|
|
235
|
-
from webhook_platform_sdk import Producer
|
|
236
|
-
|
|
237
|
-
with Producer("http://localhost:8000", "whk_...") as producer:
|
|
238
|
-
event = producer.send_event(
|
|
239
|
-
"order.created",
|
|
240
|
-
{"order_id": "42"},
|
|
241
|
-
"order-42-created",
|
|
242
|
-
)
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
The producer performs no implicit HTTP retries. If the result is ambiguous,
|
|
246
|
-
retry with the same idempotency key. `ApiError` exposes only status, bounded
|
|
247
|
-
error code, and bounded `Retry-After`; it never embeds raw response content.
|
|
248
|
-
|
|
249
|
-
Receiver code must pass the exact unparsed bytes to `verify_request` or
|
|
250
|
-
`verify_and_claim`. The latter accepts a durable `claim(event_id)` implementation.
|
|
251
|
-
Reserve the ID in the same transaction as durable receiver acceptance or state
|
|
252
|
-
changes, and return 2xx for a verified duplicate.
|
|
253
|
-
|
|
254
|
-
Install `.[outbox]` for `enqueue_outbox` and `OutboxRelay`. Enqueue in the
|
|
255
|
-
application transaction; the relay claims a bounded batch, commits, sends
|
|
256
|
-
outside the transaction, and finalizes with a lease token. A crash can resend,
|
|
257
|
-
so the relay always retains the same platform idempotency key.
|
|
258
|
-
|
|
259
|
-
`webhookctl auth register` and `webhookctl auth login` prompt for passwords
|
|
260
|
-
without placing them in process arguments. Login stores the bearer token in a
|
|
261
|
-
mode-`0600` file bound to the service base URL; `WEBHOOK_PLATFORM_TOKEN` can
|
|
262
|
-
override it for ephemeral environments. Organization, project, API-key, and
|
|
263
|
-
endpoint commands cover initial setup. Producer credentials come only from
|
|
264
|
-
`WEBHOOK_PLATFORM_API_KEY`. Capture one-time API keys and endpoint secrets
|
|
265
|
-
directly into a secret manager.
|
|
266
|
-
|
|
267
|
-
Endpoints subscribe to every event unless created with an event-type filter.
|
|
268
|
-
`webhookctl endpoints create --event-type order.* --event-type user.created`
|
|
269
|
-
restricts fan-out to exact types and trailing `prefix.*` wildcards; the field
|
|
270
|
-
is omitted from the request when no filter is given, so the command also works
|
|
271
|
-
against servers that predate subscription filtering. `webhookctl endpoints
|
|
272
|
-
update` changes the URL, description, or active state, replaces the
|
|
273
|
-
subscription list with repeated `--event-type` flags, or clears it with
|
|
274
|
-
`--all-events`. The same operations are available programmatically through
|
|
275
|
-
`ManagementClient.create_endpoint(..., event_types=...)` and
|
|
276
|
-
`ManagementClient.update_endpoint`, where passing `event_types=None`
|
|
277
|
-
explicitly clears the filter.
|
fastapi_microservices_platform_sdk-0.1.1/src/fastapi_microservices_platform_sdk.egg-info/PKG-INFO
DELETED
|
@@ -1,277 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: fastapi-microservices-platform-sdk
|
|
3
|
-
Version: 0.1.1
|
|
4
|
-
Summary: Python SDK and CLI for FastAPI Microservices Platform event delivery
|
|
5
|
-
Author: FastAPI Microservices Platform contributors
|
|
6
|
-
License: Apache License
|
|
7
|
-
Version 2.0, January 2004
|
|
8
|
-
http://www.apache.org/licenses/
|
|
9
|
-
|
|
10
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
11
|
-
|
|
12
|
-
1. Definitions.
|
|
13
|
-
|
|
14
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
15
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
16
|
-
|
|
17
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
18
|
-
the copyright owner that is granting the License.
|
|
19
|
-
|
|
20
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
21
|
-
other entities that control, are controlled by, or are under common
|
|
22
|
-
control with that entity. For the purposes of this definition,
|
|
23
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
24
|
-
direction or management of such entity, whether by contract or
|
|
25
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
26
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
27
|
-
|
|
28
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
29
|
-
exercising permissions granted by this License.
|
|
30
|
-
|
|
31
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
32
|
-
including but not limited to software source code, documentation
|
|
33
|
-
source, and configuration files.
|
|
34
|
-
|
|
35
|
-
"Object" form shall mean any form resulting from mechanical
|
|
36
|
-
transformation or translation of a Source form, including but
|
|
37
|
-
not limited to compiled object code, generated documentation,
|
|
38
|
-
and conversions to other media types.
|
|
39
|
-
|
|
40
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
41
|
-
Object form, made available under the License, as indicated by a
|
|
42
|
-
copyright notice that is included in or attached to the work
|
|
43
|
-
(an example is provided in the Appendix below).
|
|
44
|
-
|
|
45
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
46
|
-
form, that is based on (or derived from) the Work and for which the
|
|
47
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
48
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
49
|
-
of this License, Derivative Works shall not include works that remain
|
|
50
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
51
|
-
the Work and Derivative Works thereof.
|
|
52
|
-
|
|
53
|
-
"Contribution" shall mean any work of authorship, including
|
|
54
|
-
the original version of the Work and any modifications or additions
|
|
55
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
56
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
57
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
58
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
59
|
-
means any form of electronic, verbal, or written communication sent
|
|
60
|
-
to the Licensor or its representatives, including but not limited to
|
|
61
|
-
communication on electronic mailing lists, source code control systems,
|
|
62
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
63
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
64
|
-
excluding communication that is conspicuously marked or otherwise
|
|
65
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
66
|
-
|
|
67
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
68
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
69
|
-
subsequently incorporated within the Work.
|
|
70
|
-
|
|
71
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
72
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
73
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
74
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
75
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
76
|
-
Work and such Derivative Works in Source or Object form.
|
|
77
|
-
|
|
78
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
79
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
80
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
81
|
-
(except as stated in this section) patent license to make, have made,
|
|
82
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
83
|
-
where such license applies only to those patent claims licensable
|
|
84
|
-
by such Contributor that are necessarily infringed by their
|
|
85
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
86
|
-
with the Work to which such Contribution(s) was submitted.
|
|
87
|
-
If You institute patent litigation against any entity (including a
|
|
88
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
89
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
90
|
-
or contributory patent infringement, then any patent licenses
|
|
91
|
-
granted to You under this License for that Work shall terminate
|
|
92
|
-
as of the date such litigation is filed.
|
|
93
|
-
|
|
94
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
95
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
96
|
-
modifications, and in Source or Object form, provided that You
|
|
97
|
-
meet the following conditions:
|
|
98
|
-
|
|
99
|
-
(a) You must give any other recipients of the Work or
|
|
100
|
-
Derivative Works a copy of this License; and
|
|
101
|
-
|
|
102
|
-
(b) You must cause any modified files to carry prominent notices
|
|
103
|
-
stating that You changed the files; and
|
|
104
|
-
|
|
105
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
106
|
-
that You distribute, all copyright, patent, trademark, and
|
|
107
|
-
attribution notices from the Source form of the Work,
|
|
108
|
-
excluding those notices that do not pertain to any part of
|
|
109
|
-
the Derivative Works; and
|
|
110
|
-
|
|
111
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
112
|
-
distribution, then any Derivative Works that You distribute must
|
|
113
|
-
include a readable copy of the attribution notices contained
|
|
114
|
-
within such NOTICE file, excluding those notices that do not
|
|
115
|
-
pertain to any part of the Derivative Works, in at least one
|
|
116
|
-
of the following places: within a NOTICE text file distributed
|
|
117
|
-
as part of the Derivative Works; within the Source form or
|
|
118
|
-
documentation, if provided along with the Derivative Works; or,
|
|
119
|
-
within a display generated by the Derivative Works, if and
|
|
120
|
-
wherever such third-party notices normally appear. The contents
|
|
121
|
-
of the NOTICE file are for informational purposes only and
|
|
122
|
-
do not modify the License. You may add Your own attribution
|
|
123
|
-
notices within Derivative Works that You distribute, alongside
|
|
124
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
125
|
-
that such additional attribution notices cannot be construed
|
|
126
|
-
as modifying the License.
|
|
127
|
-
|
|
128
|
-
You may add Your own copyright statement to Your modifications and
|
|
129
|
-
may provide additional or different license terms and conditions
|
|
130
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
131
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
132
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
133
|
-
the conditions stated in this License.
|
|
134
|
-
|
|
135
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
136
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
137
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
138
|
-
this License, without any additional terms or conditions.
|
|
139
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
140
|
-
the terms of any separate license agreement you may have executed
|
|
141
|
-
with Licensor regarding such Contributions.
|
|
142
|
-
|
|
143
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
144
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
145
|
-
except as required for reasonable and customary use in describing the
|
|
146
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
147
|
-
|
|
148
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
149
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
150
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
151
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
152
|
-
implied, including, without limitation, any warranties or conditions
|
|
153
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
154
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
155
|
-
appropriateness of using or redistributing the Work and assume any
|
|
156
|
-
risks associated with Your exercise of permissions under this License.
|
|
157
|
-
|
|
158
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
159
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
160
|
-
unless required by applicable law (such as deliberate and grossly
|
|
161
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
162
|
-
liable to You for damages, including any direct, indirect, special,
|
|
163
|
-
incidental, or consequential damages of any character arising as a
|
|
164
|
-
result of this License or out of the use or inability to use the
|
|
165
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
166
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
167
|
-
other commercial damages or losses), even if such Contributor
|
|
168
|
-
has been advised of the possibility of such damages.
|
|
169
|
-
|
|
170
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
171
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
172
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
173
|
-
or other liability obligations and/or rights consistent with this
|
|
174
|
-
License. However, in accepting such obligations, You may act only
|
|
175
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
176
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
177
|
-
defend, and hold each Contributor harmless for any liability
|
|
178
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
179
|
-
of your accepting any such warranty or additional liability.
|
|
180
|
-
|
|
181
|
-
END OF TERMS AND CONDITIONS
|
|
182
|
-
|
|
183
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
184
|
-
|
|
185
|
-
To apply the Apache License to your work, attach the following
|
|
186
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
187
|
-
replaced with your own identifying information. (Don't include
|
|
188
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
189
|
-
comment syntax for the file format. We also recommend that a
|
|
190
|
-
file or class name and description of purpose be included on the
|
|
191
|
-
same "printed page" as the copyright notice for easier
|
|
192
|
-
identification within third-party archives.
|
|
193
|
-
|
|
194
|
-
Copyright 2026 Amit Singh
|
|
195
|
-
|
|
196
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
197
|
-
you may not use this file except in compliance with the License.
|
|
198
|
-
You may obtain a copy of the License at
|
|
199
|
-
|
|
200
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
201
|
-
|
|
202
|
-
Unless required by applicable law or agreed to in writing, software
|
|
203
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
204
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
205
|
-
See the License for the specific language governing permissions and
|
|
206
|
-
limitations under the License.
|
|
207
|
-
|
|
208
|
-
Project-URL: Repository, https://github.com/AmitSinghOM/fastapi-microservices-platform
|
|
209
|
-
Project-URL: Documentation, https://github.com/AmitSinghOM/fastapi-microservices-platform/blob/main/docs/phase8-adoption.md
|
|
210
|
-
Project-URL: Issues, https://github.com/AmitSinghOM/fastapi-microservices-platform/issues
|
|
211
|
-
Classifier: Programming Language :: Python :: 3
|
|
212
|
-
Classifier: License :: OSI Approved :: Apache Software License
|
|
213
|
-
Requires-Python: >=3.11
|
|
214
|
-
Description-Content-Type: text/markdown
|
|
215
|
-
License-File: LICENSE
|
|
216
|
-
Requires-Dist: httpx==0.28.1
|
|
217
|
-
Provides-Extra: outbox
|
|
218
|
-
Requires-Dist: SQLAlchemy==2.0.36; extra == "outbox"
|
|
219
|
-
Provides-Extra: test
|
|
220
|
-
Requires-Dist: pytest==8.3.4; extra == "test"
|
|
221
|
-
Requires-Dist: SQLAlchemy==2.0.36; extra == "test"
|
|
222
|
-
|
|
223
|
-
# FastAPI Microservices Platform Python SDK
|
|
224
|
-
|
|
225
|
-
The `fastapi-microservices-platform-sdk` distribution provides a synchronous
|
|
226
|
-
producer, control-plane client, raw-byte receiver verification, a SQLAlchemy
|
|
227
|
-
transactional outbox, and `webhookctl`. Its Python import remains
|
|
228
|
-
`webhook_platform_sdk`. Python 3.11+ is required.
|
|
229
|
-
|
|
230
|
-
```bash
|
|
231
|
-
python -m pip install .
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
```python
|
|
235
|
-
from webhook_platform_sdk import Producer
|
|
236
|
-
|
|
237
|
-
with Producer("http://localhost:8000", "whk_...") as producer:
|
|
238
|
-
event = producer.send_event(
|
|
239
|
-
"order.created",
|
|
240
|
-
{"order_id": "42"},
|
|
241
|
-
"order-42-created",
|
|
242
|
-
)
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
The producer performs no implicit HTTP retries. If the result is ambiguous,
|
|
246
|
-
retry with the same idempotency key. `ApiError` exposes only status, bounded
|
|
247
|
-
error code, and bounded `Retry-After`; it never embeds raw response content.
|
|
248
|
-
|
|
249
|
-
Receiver code must pass the exact unparsed bytes to `verify_request` or
|
|
250
|
-
`verify_and_claim`. The latter accepts a durable `claim(event_id)` implementation.
|
|
251
|
-
Reserve the ID in the same transaction as durable receiver acceptance or state
|
|
252
|
-
changes, and return 2xx for a verified duplicate.
|
|
253
|
-
|
|
254
|
-
Install `.[outbox]` for `enqueue_outbox` and `OutboxRelay`. Enqueue in the
|
|
255
|
-
application transaction; the relay claims a bounded batch, commits, sends
|
|
256
|
-
outside the transaction, and finalizes with a lease token. A crash can resend,
|
|
257
|
-
so the relay always retains the same platform idempotency key.
|
|
258
|
-
|
|
259
|
-
`webhookctl auth register` and `webhookctl auth login` prompt for passwords
|
|
260
|
-
without placing them in process arguments. Login stores the bearer token in a
|
|
261
|
-
mode-`0600` file bound to the service base URL; `WEBHOOK_PLATFORM_TOKEN` can
|
|
262
|
-
override it for ephemeral environments. Organization, project, API-key, and
|
|
263
|
-
endpoint commands cover initial setup. Producer credentials come only from
|
|
264
|
-
`WEBHOOK_PLATFORM_API_KEY`. Capture one-time API keys and endpoint secrets
|
|
265
|
-
directly into a secret manager.
|
|
266
|
-
|
|
267
|
-
Endpoints subscribe to every event unless created with an event-type filter.
|
|
268
|
-
`webhookctl endpoints create --event-type order.* --event-type user.created`
|
|
269
|
-
restricts fan-out to exact types and trailing `prefix.*` wildcards; the field
|
|
270
|
-
is omitted from the request when no filter is given, so the command also works
|
|
271
|
-
against servers that predate subscription filtering. `webhookctl endpoints
|
|
272
|
-
update` changes the URL, description, or active state, replaces the
|
|
273
|
-
subscription list with repeated `--event-type` flags, or clears it with
|
|
274
|
-
`--all-events`. The same operations are available programmatically through
|
|
275
|
-
`ManagementClient.create_endpoint(..., event_types=...)` and
|
|
276
|
-
`ManagementClient.update_endpoint`, where passing `event_types=None`
|
|
277
|
-
explicitly clears the filter.
|
{fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/LICENSE
RENAMED
|
File without changes
|
{fastapi_microservices_platform_sdk-0.1.1 → fastapi_microservices_platform_sdk-0.1.2}/setup.cfg
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|