github-events 0.1.0__tar.gz

github_events-0.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.3
+Name: github-events
+Version: 0.1.0
+Summary: TypedDicts for every GitHub webhook event, with optional pydantic validation and FastAPI dispatch
+Requires-Dist: typing-extensions>=4.12
+Requires-Dist: fastapi>=0.110 ; extra == 'fastapi'
+Requires-Dist: pydantic>=2.0 ; extra == 'fastapi'
+Requires-Dist: pydantic>=2.0 ; extra == 'pydantic'
+Requires-Python: >=3.11
+Provides-Extra: fastapi
+Provides-Extra: pydantic
+Description-Content-Type: text/markdown
+
+# github-events
+
+Typed GitHub webhook payloads, HMAC signature verification, and event dispatch.
+
+```sh
+pip install github-events
+# Optional payload validation and FastAPI integration:
+pip install 'github-events[fastapi]'
+```
+
+```python
+import os
+from github_events import WebhookDispatcher
+
+hooks = WebhookDispatcher(secret=os.environ["GITHUB_WEBHOOK_SECRET"])
+
+@hooks.on("push")
+async def on_push(payload):
+    print(payload["ref"])
+```
+
+Pass the raw request body and GitHub webhook headers to the dispatcher, or mount
+its `as_fastapi_router()` in your FastAPI application. The base package depends only on `typing-extensions`. The `pydantic` extra adds validation; the `fastapi` extra
+adds the HTTP integration and validation dependencies.

github_events-0.1.0/README.md

@@ -0,0 +1,24 @@
+# github-events
+
+Typed GitHub webhook payloads, HMAC signature verification, and event dispatch.
+
+```sh
+pip install github-events
+# Optional payload validation and FastAPI integration:
+pip install 'github-events[fastapi]'
+```
+
+```python
+import os
+from github_events import WebhookDispatcher
+
+hooks = WebhookDispatcher(secret=os.environ["GITHUB_WEBHOOK_SECRET"])
+
+@hooks.on("push")
+async def on_push(payload):
+    print(payload["ref"])
+```
+
+Pass the raw request body and GitHub webhook headers to the dispatcher, or mount
+its `as_fastapi_router()` in your FastAPI application. The base package depends only on `typing-extensions`. The `pydantic` extra adds validation; the `fastapi` extra
+adds the HTTP integration and validation dependencies.

github_events-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "github-events"
+version = "0.1.0"
+description = "TypedDicts for every GitHub webhook event, with optional pydantic validation and FastAPI dispatch"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = ["typing-extensions>=4.12"]
+
+[project.optional-dependencies]
+pydantic = ["pydantic>=2.0"]
+fastapi = ["fastapi>=0.110", "pydantic>=2.0"]
+
+[dependency-groups]
+dev = [
+    "fastapi>=0.110",
+    "httpx>=0.28",
+    "pydantic>=2.0",
+    "pytest>=9.0",
+    "pytest-asyncio>=1.4",
+]
+
+[build-system]
+requires = ["uv_build>=0.11,<0.12"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

github_events-0.1.0/src/github_events/__init__.py

@@ -0,0 +1,42 @@
+"""TypedDicts for every GitHub webhook event, plus dispatch.
+
+Core (typing-extensions only): the payload TypedDicts (re-exported here), the event
+registry, and WebhookDispatcher (signature verification + routing). Optional
+extras: github-events[pydantic] adds payload validation (used automatically by
+WebhookDispatcher when pydantic is installed); github-events[fastapi] adds a
+mountable endpoint via WebhookDispatcher.as_fastapi_router().
+
+Payload types are named `<Event>Event` / `<Event><Action>Event` — PushEvent,
+IssuesOpenedEvent, PullRequestClosedEvent, ... — and each actioned event also
+has a union alias (IssuesEvent = IssuesAssignedEvent | IssuesClosedEvent | ...).
+WebhookEvent unions all of them.
+"""
+
+from github_events import _models
+from github_events._models import *  # noqa: F403 - generated re-export
+from github_events._registry import (
+    ACTION_EVENTS,
+    ACTION_TYPES,
+    EVENT_NAMES,
+    EVENT_TYPES,
+    EventName,
+    WebhookEvent,
+)
+from github_events.dispatch import (
+    SignatureVerificationError,
+    WebhookDispatcher,
+    WebhookError,
+)
+
+__all__ = [
+    *_models.__all__,
+    "ACTION_EVENTS",
+    "ACTION_TYPES",
+    "EVENT_NAMES",
+    "EVENT_TYPES",
+    "EventName",
+    "SignatureVerificationError",
+    "WebhookDispatcher",
+    "WebhookError",
+    "WebhookEvent",
+]