chore: housekeeping — py.typed, verify_webhook, dependabot#21
Merged
jackparnell merged 1 commit intomainfrom Apr 9, 2026
Merged
chore: housekeeping — py.typed, verify_webhook, dependabot#21jackparnell merged 1 commit intomainfrom
jackparnell merged 1 commit intomainfrom
Conversation
Three small unrelated improvements bundled together: 1. py.typed marker (PEP 561) — empty file at src/colony_sdk/py.typed so mypy/pyright recognise colony_sdk as a typed package and pick up our type hints without --ignore-missing-imports. Verified to ship in the wheel via hatchling's automatic inclusion. 2. verify_webhook(payload, signature, secret) — HMAC-SHA256 verification helper for incoming webhook deliveries. Matches the canonical X-Colony-Signature format (raw body, hex digest, no prefix). Uses hmac.compare_digest for constant-time comparison. Tolerates a leading "sha256=" prefix on the signature for frameworks that normalise that way. Accepts bytes or str payloads. 3. Dependabot config — .github/dependabot.yml watches pip and github-actions weekly, grouped into single PRs to keep noise low. Tests: 10 new verify_webhook tests covering bytes/str payloads, valid sig, invalid sig, wrong secret, tampered payload, sha256= prefix, malformed/empty signature, empty body, unicode body. Coverage stays at 100% (470/470 statements). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ColonistOne
added a commit
that referenced
this pull request
Apr 9, 2026
Two changes that ship together so v1.5.0 can be the first release cut
via the new automation:
1. Release workflow at .github/workflows/release.yml — triggered on
`v*` tag push. Stages:
- test: runs ruff, mypy, pytest before anything else
- build: builds wheel + sdist, refuses to proceed if
the tag version doesn't match pyproject.toml
- publish: uploads to PyPI via OIDC trusted publishing
(no API token stored anywhere — short-lived
token minted by PyPI from the GitHub Actions
OIDC identity at publish time)
- github-release: extracts the matching CHANGELOG section and
creates a GitHub Release with the wheel + sdist
attached
2. Version bump 1.4.0 → 1.5.0 in pyproject.toml and __init__.py.
3. CHANGELOG: consolidated the 1.5.0 section into a clean, ordered
summary covering everything that's landed since 1.4.0:
- AsyncColonyClient (PR #18)
- Typed error hierarchy (PR #19)
- RetryConfig + 5xx default retry (PR #20)
- py.typed + verify_webhook + Dependabot (PR #21)
- Pagination iterators (PR #23)
- Coverage + Codecov (PR #17)
- This release automation
Coverage at 100% (514/514 statements). 215 tests passing.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
6 tasks
ColonistOne
added a commit
that referenced
this pull request
Apr 9, 2026
Two changes that ship together so v1.5.0 can be the first release cut
via the new automation:
1. Release workflow at .github/workflows/release.yml — triggered on
`v*` tag push. Stages:
- test: runs ruff, mypy, pytest before anything else
- build: builds wheel + sdist, refuses to proceed if
the tag version doesn't match pyproject.toml
- publish: uploads to PyPI via OIDC trusted publishing
(no API token stored anywhere — short-lived
token minted by PyPI from the GitHub Actions
OIDC identity at publish time)
- github-release: extracts the matching CHANGELOG section and
creates a GitHub Release with the wheel + sdist
attached
2. Version bump 1.4.0 → 1.5.0 in pyproject.toml and __init__.py.
3. CHANGELOG: consolidated the 1.5.0 section into a clean, ordered
summary covering everything that's landed since 1.4.0:
- AsyncColonyClient (PR #18)
- Typed error hierarchy (PR #19)
- RetryConfig + 5xx default retry (PR #20)
- py.typed + verify_webhook + Dependabot (PR #21)
- Pagination iterators (PR #23)
- Coverage + Codecov (PR #17)
- This release automation
Coverage at 100% (514/514 statements). 215 tests passing.
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three small unrelated improvements bundled together.
1. PEP 561
py.typedmarkerEmpty file at
src/colony_sdk/py.typedso type checkers (mypy, pyright) recognisecolony_sdkas a typed package and pick up our type hints out of the box. Verified to ship in the built wheel via hatchling's automatic inclusion.Without this marker, downstream consumers' type checkers silently ignore all of
colony_sdk's type hints unless they pass--ignore-missing-imports.2.
verify_webhook(payload, signature, secret)helperHMAC-SHA256 verification for incoming Colony webhook deliveries. Matches the canonical signing format used by The Colony's webhook server:
X-Colony-SignatureImplementation notes:
hmac.compare_digest(timing-attack resistant)bytes(preferred) orstrpayloads"sha256="prefix for frameworks that normalise that wayFalsefor malformed/empty signatures rather than raising3. Dependabot config
.github/dependabot.ymlwatchespipandgithub-actionsweekly, grouped into single PRs to keep noise low (one PR per ecosystem per week instead of one PR per dependency).Test plan
TestVerifyWebhooktests: bytes/str payloads, valid sig, invalid sig, wrong secret, tampered payload,sha256=prefix, malformed/empty signature, empty body, unicode bodypy.typedships in the built wheel (python -m build && unzip -l dist/*.whl)ruff check/ruff format --check/mypy src/all clean