notificme 0.1.0__tar.gz

notificme-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# OS and editors
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# Node
+node_modules/
+typescript/dist/
+typescript/LICENSE
+*.tgz
+
+# Python
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+python/dist/
+python/build/
+*.egg-info/
+
+# Secrets
+.env
+.env.*

notificme-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

notificme-0.1.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.5
+Name: notificme
+Version: 0.1.0
+Summary: Official Python SDK for notific.me: send events, keep live cards up to date, ask humans for decisions and verify signed webhooks.
+Project-URL: Homepage, https://notific.me
+Project-URL: Source, https://github.com/idIe-ai/notificme-sdk/tree/main/python
+Project-URL: Issues, https://github.com/idIe-ai/notificme-sdk/issues
+Author: IDIE Consulting Technology
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: approval,human-in-the-loop,notific.me,notifications,sdk,webhooks
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: cryptography>=41
+Requires-Dist: httpx<1,>=0.25
+Requires-Dist: typing-extensions>=4.7; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# notificme
+
+Official Python SDK for [notific.me](https://notific.me). It sends events, keeps live cards up to date, asks people for decisions and waits for the answer, and verifies the signed webhooks the server sends you.
+
+- Python 3.10+, sync (`NotificMe`) and async (`AsyncNotificMe`) clients.
+- Built on [httpx](https://www.python-httpx.org/); webhook signatures use [cryptography](https://cryptography.io/) (Ed25519).
+- Retries 429, 5xx and network errors (honouring `Retry-After`), with a timeout on every request.
+- Fully typed (`py.typed`).
+
+## Installation
+
+```sh
+pip install notificme
+```
+
+## Quick start
+
+Create a service token in the customer area. It needs the `events:write`, `asks:write` and `asks:read` scopes. Keep the token on your server.
+
+```python
+from notificme import NotificMe
+
+notific = NotificMe(token="nm_svc_...", source="billing")  # or set NOTIFICME_TOKEN
+
+notific.send("invoice.failed", severity="high", summary="Invoice #42 failed")
+```
+
+| Argument | Default | |
+| --- | --- | --- |
+| `token` | `NOTIFICME_TOKEN` env var | Service token (`nm_svc_…`). |
+| `base_url` | `NOTIFICME_URL` or `https://api.notific.me` | API address. |
+| `source` | none | Default `source` of your events. |
+| `timeout` | `30.0` | Per-request timeout (seconds). |
+| `max_retries` | `3` | Retries on 429, 5xx and network errors. |
+| `retry_base_delay` / `retry_max_delay` | `0.5` / `10.0` | Exponential backoff with jitter (seconds). |
+| `http_client` | new `httpx.Client` | Your own client (proxies, mounts, tests). |
+
+Use the client as a context manager (`with NotificMe(...) as notific:`) or call `close()` to release connections.
+
+## Sending events
+
+```python
+notific.send(
+    "container.die",  # dotted lowercase type
+    severity="high",  # info | low | medium | high | critical (default: info)
+    summary="api-v2 died on vps-01",
+    dedup_key="vps-01/api-v2",  # merges repeats in the dedup window
+    expires_when="container.healthy",
+    payload={"host": "vps-01", "exit_code": 137},  # sent as is
+    card={
+        "title": "Container died",
+        "blocks": [
+            {"type": "metric", "label": "Crashes in 24h", "value": 3},
+            {
+                "type": "buttons",
+                "buttons": [{"label": "Open dashboard", "url": "https://dokploy.example.com"}],
+            },
+        ],
+    },
+)
+```
+
+Cards and questions use the protocol's snake_case, exactly as in [`protocol/schemas`](https://github.com/idIe-ai/notificme-sdk/tree/main/protocol/schemas). Every event gets an idempotency `id`, so a retried request is not stored twice. You can also pass your own `id`.
+
+### Live cards
+
+```python
+deploy = notific.send(
+    "deploy.progress",
+    summary="Deploying api",
+    live=True,  # the SDK creates a card_id; you can also pass your own card_id
+    card={"blocks": [{"type": "progress", "value": 0.1}]},
+)
+
+notific.update(deploy.card_id, card={"blocks": [{"type": "progress", "value": 0.8}]})
+```
+
+`update()` takes `type`, `source`, `severity` and `summary` from the last event this client sent for that card. You can override any of them.
+
+## Asking humans
+
+```python
+result = notific.ask(
+    "Deploy api to production?",
+    [
+        {
+            "id": "action",
+            "type": "single",
+            "text": "What should we do?",
+            "options": ["Deploy", "Wait"],
+            "allow_other": True,
+        },
+        {"id": "note", "type": "text", "text": "Anything else?", "optional": True},
+    ],
+    to="ops",
+    timeout="30m",
+    on_timeout={"action": "Wait"},
+)
+
+if result.status == "answered" and result.answers["action"] == "Deploy":
+    ...
+
+print(result.as_text)  # natural-language summary, ready for an AI agent
+```
+
+`ask()` long-polls until the reply arrives or the question set times out (`result.status == "timeout"`, with `on_timeout` applied). It raises `AskClosedError` when the question set expires or is cancelled. Pass `max_wait=` (seconds) to stop waiting earlier: it raises `AskPendingError`, and you can resume with `notific.wait_for_reply(err.ask_id)`.
+
+Answers are converted per question type: `yesno` → `bool`, `single` → `str`, `multi` → `list[str]`, `number` → number, `date` → `str`, `voice` → `VoiceAnswer`, `text` → `UntrustedText`.
+
+To create the question set without waiting, use `create_ask()` (returns a handle with `.wait()`), or set `callback_url=` and receive the reply on a webhook.
+
+### Untrusted text
+
+Anything a human typed comes back as `UntrustedText`. Never feed it to a shell, SQL, `eval`, HTML or an LLM prompt as instructions. Read it on purpose with `.text`, or embed it as a quoted JSON string with `.quoted()`.
+
+## Async
+
+```python
+from notificme import AsyncNotificMe
+
+async with AsyncNotificMe(source="agent") as notific:
+    await notific.send("agent.started", summary="Agent started")
+    result = await notific.ask("Run the migration?", [{"id": "ok", "type": "yesno", "text": "Go?"}])
+```
+
+## Verifying webhooks
+
+Every webhook carries a `Notificme-Signature` header signed with Ed25519. Always verify the **raw** body.
+
+```python
+# FastAPI
+from fastapi import FastAPI, Request
+from notificme import NotificMe, WebhookVerificationError
+
+app = FastAPI()
+notific = NotificMe(source="billing")
+
+
+@app.post("/notificme")
+async def hook(request: Request):
+    body = await request.body()
+    try:
+        webhook = notific.receive_webhook(body, request.headers)
+    except WebhookVerificationError:
+        return {"ok": False}, 400
+    if webhook.reply:
+        print(webhook.reply.answers)
+    return {"ok": True}
+```
+
+```python
+# Flask
+from flask import Flask, request
+from notificme import NotificMe
+
+app = Flask(__name__)
+notific = NotificMe(source="billing")
+
+
+@app.post("/notificme")
+def hook():
+    webhook = notific.receive_webhook(request.get_data(), request.headers)
+    return {"ok": True}
+```
+
+Without a client, pass the key explicitly: `receive_webhook(body, headers, "https://api.notific.me/.well-known/notificme-keys.json")`. The key can also be the base64url public key, raw bytes, a JWK or a JWKS. Keys fetched from a URL are cached for 10 minutes and refreshed when an unknown `kid` shows up.
+
+Use `webhook.id` (`Notificme-Webhook-Id`) to deduplicate: it is the same on every retry.
+
+## Errors
+
+| Error | When |
+| --- | --- |
+| `NotificMeApiError` | The API answered with a non-2xx status (`status`, `code`, `details`, `request_id`). |
+| `AskClosedError` | The question set expired or was cancelled. |
+| `AskPendingError` | `max_wait` elapsed while the question set is still open. |
+| `WebhookVerificationError` | Bad or missing signature (`reason`). |
+| `NotificMeError` | Base class; client-side failures such as `timeout` and `network_error`. |
+
+## License
+
+Apache 2.0.

notificme-0.1.0/README.md

@@ -0,0 +1,182 @@
+# notificme
+
+Official Python SDK for [notific.me](https://notific.me). It sends events, keeps live cards up to date, asks people for decisions and waits for the answer, and verifies the signed webhooks the server sends you.
+
+- Python 3.10+, sync (`NotificMe`) and async (`AsyncNotificMe`) clients.
+- Built on [httpx](https://www.python-httpx.org/); webhook signatures use [cryptography](https://cryptography.io/) (Ed25519).
+- Retries 429, 5xx and network errors (honouring `Retry-After`), with a timeout on every request.
+- Fully typed (`py.typed`).
+
+## Installation
+
+```sh
+pip install notificme
+```
+
+## Quick start
+
+Create a service token in the customer area. It needs the `events:write`, `asks:write` and `asks:read` scopes. Keep the token on your server.
+
+```python
+from notificme import NotificMe
+
+notific = NotificMe(token="nm_svc_...", source="billing")  # or set NOTIFICME_TOKEN
+
+notific.send("invoice.failed", severity="high", summary="Invoice #42 failed")
+```
+
+| Argument | Default | |
+| --- | --- | --- |
+| `token` | `NOTIFICME_TOKEN` env var | Service token (`nm_svc_…`). |
+| `base_url` | `NOTIFICME_URL` or `https://api.notific.me` | API address. |
+| `source` | none | Default `source` of your events. |
+| `timeout` | `30.0` | Per-request timeout (seconds). |
+| `max_retries` | `3` | Retries on 429, 5xx and network errors. |
+| `retry_base_delay` / `retry_max_delay` | `0.5` / `10.0` | Exponential backoff with jitter (seconds). |
+| `http_client` | new `httpx.Client` | Your own client (proxies, mounts, tests). |
+
+Use the client as a context manager (`with NotificMe(...) as notific:`) or call `close()` to release connections.
+
+## Sending events
+
+```python
+notific.send(
+    "container.die",  # dotted lowercase type
+    severity="high",  # info | low | medium | high | critical (default: info)
+    summary="api-v2 died on vps-01",
+    dedup_key="vps-01/api-v2",  # merges repeats in the dedup window
+    expires_when="container.healthy",
+    payload={"host": "vps-01", "exit_code": 137},  # sent as is
+    card={
+        "title": "Container died",
+        "blocks": [
+            {"type": "metric", "label": "Crashes in 24h", "value": 3},
+            {
+                "type": "buttons",
+                "buttons": [{"label": "Open dashboard", "url": "https://dokploy.example.com"}],
+            },
+        ],
+    },
+)
+```
+
+Cards and questions use the protocol's snake_case, exactly as in [`protocol/schemas`](https://github.com/idIe-ai/notificme-sdk/tree/main/protocol/schemas). Every event gets an idempotency `id`, so a retried request is not stored twice. You can also pass your own `id`.
+
+### Live cards
+
+```python
+deploy = notific.send(
+    "deploy.progress",
+    summary="Deploying api",
+    live=True,  # the SDK creates a card_id; you can also pass your own card_id
+    card={"blocks": [{"type": "progress", "value": 0.1}]},
+)
+
+notific.update(deploy.card_id, card={"blocks": [{"type": "progress", "value": 0.8}]})
+```
+
+`update()` takes `type`, `source`, `severity` and `summary` from the last event this client sent for that card. You can override any of them.
+
+## Asking humans
+
+```python
+result = notific.ask(
+    "Deploy api to production?",
+    [
+        {
+            "id": "action",
+            "type": "single",
+            "text": "What should we do?",
+            "options": ["Deploy", "Wait"],
+            "allow_other": True,
+        },
+        {"id": "note", "type": "text", "text": "Anything else?", "optional": True},
+    ],
+    to="ops",
+    timeout="30m",
+    on_timeout={"action": "Wait"},
+)
+
+if result.status == "answered" and result.answers["action"] == "Deploy":
+    ...
+
+print(result.as_text)  # natural-language summary, ready for an AI agent
+```
+
+`ask()` long-polls until the reply arrives or the question set times out (`result.status == "timeout"`, with `on_timeout` applied). It raises `AskClosedError` when the question set expires or is cancelled. Pass `max_wait=` (seconds) to stop waiting earlier: it raises `AskPendingError`, and you can resume with `notific.wait_for_reply(err.ask_id)`.
+
+Answers are converted per question type: `yesno` → `bool`, `single` → `str`, `multi` → `list[str]`, `number` → number, `date` → `str`, `voice` → `VoiceAnswer`, `text` → `UntrustedText`.
+
+To create the question set without waiting, use `create_ask()` (returns a handle with `.wait()`), or set `callback_url=` and receive the reply on a webhook.
+
+### Untrusted text
+
+Anything a human typed comes back as `UntrustedText`. Never feed it to a shell, SQL, `eval`, HTML or an LLM prompt as instructions. Read it on purpose with `.text`, or embed it as a quoted JSON string with `.quoted()`.
+
+## Async
+
+```python
+from notificme import AsyncNotificMe
+
+async with AsyncNotificMe(source="agent") as notific:
+    await notific.send("agent.started", summary="Agent started")
+    result = await notific.ask("Run the migration?", [{"id": "ok", "type": "yesno", "text": "Go?"}])
+```
+
+## Verifying webhooks
+
+Every webhook carries a `Notificme-Signature` header signed with Ed25519. Always verify the **raw** body.
+
+```python
+# FastAPI
+from fastapi import FastAPI, Request
+from notificme import NotificMe, WebhookVerificationError
+
+app = FastAPI()
+notific = NotificMe(source="billing")
+
+
+@app.post("/notificme")
+async def hook(request: Request):
+    body = await request.body()
+    try:
+        webhook = notific.receive_webhook(body, request.headers)
+    except WebhookVerificationError:
+        return {"ok": False}, 400
+    if webhook.reply:
+        print(webhook.reply.answers)
+    return {"ok": True}
+```
+
+```python
+# Flask
+from flask import Flask, request
+from notificme import NotificMe
+
+app = Flask(__name__)
+notific = NotificMe(source="billing")
+
+
+@app.post("/notificme")
+def hook():
+    webhook = notific.receive_webhook(request.get_data(), request.headers)
+    return {"ok": True}
+```
+
+Without a client, pass the key explicitly: `receive_webhook(body, headers, "https://api.notific.me/.well-known/notificme-keys.json")`. The key can also be the base64url public key, raw bytes, a JWK or a JWKS. Keys fetched from a URL are cached for 10 minutes and refreshed when an unknown `kid` shows up.
+
+Use `webhook.id` (`Notificme-Webhook-Id`) to deduplicate: it is the same on every retry.
+
+## Errors
+
+| Error | When |
+| --- | --- |
+| `NotificMeApiError` | The API answered with a non-2xx status (`status`, `code`, `details`, `request_id`). |
+| `AskClosedError` | The question set expired or was cancelled. |
+| `AskPendingError` | `max_wait` elapsed while the question set is still open. |
+| `WebhookVerificationError` | Bad or missing signature (`reason`). |
+| `NotificMeError` | Base class; client-side failures such as `timeout` and `network_error`. |
+
+## License
+
+Apache 2.0.

notificme-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["hatchling>=1.24"]
+build-backend = "hatchling.build"
+
+[project]
+name = "notificme"
+dynamic = ["version"]
+description = "Official Python SDK for notific.me: send events, keep live cards up to date, ask humans for decisions and verify signed webhooks."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "IDIE Consulting Technology" }]
+keywords = ["notific.me", "notifications", "human-in-the-loop", "approval", "webhooks", "sdk"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+dependencies = [
+  "httpx>=0.25,<1",
+  "cryptography>=41",
+  "typing_extensions>=4.7; python_version < '3.11'",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "ruff>=0.6", "mypy>=1.10"]
+
+[project.urls]
+Homepage = "https://notific.me"
+Source = "https://github.com/idIe-ai/notificme-sdk/tree/main/python"
+Issues = "https://github.com/idIe-ai/notificme-sdk/issues"
+
+[tool.hatch.version]
+path = "src/notificme/_version.py"
+
+[tool.hatch.build.targets.sdist]
+include = ["src/notificme", "tests", "README.md", "LICENSE"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/notificme"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 110
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP"]
+ignore = ["UP006", "UP007", "UP035", "UP045", "B008"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+files = ["src"]