📝 docs: state the proxy-vs-mixin rule in the README #190

Merged
mat merged 1 commit from docs/proxy-mixin-rule into main 2026-10-27 14:31:36 +00:00
Owner

Summary

README gains an ## Architecture section stating the proxy-vs-mixin rule:

ComwattClient
├── one mixin per API domain ── flat get_*/set_* methods
└── client.weather (WeatherProxy)
    └── rule: a domain gets a proxy ⟺ its transport differs
       from the authenticated REST path (base URL/host, protocol, auth model)
        ├── weather: unauthenticated, outside /api → proxy ✓
        └── streaming: WS + different host, but authenticated
           and session-coupled → stays a flat method (revisit on a 2nd streaming method)

Evidence

  • Before: no composition note; the weather-vs-flat split looks arbitrary (#151, first bullet).
    After: the rule is stated once, weather's proxy justified by it, streaming's deferral explicit. pytest -q → 242 passed, mypy → clean (docs-only change).

Merge Danger

Door: two-way

Blast Radius: none — documentation only.

Closes #175. Answers the first bullet of the #151 audit.

## Summary README gains an `## Architecture` section stating the proxy-vs-mixin rule: ```text ComwattClient ├── one mixin per API domain ── flat get_*/set_* methods └── client.weather (WeatherProxy) └── rule: a domain gets a proxy ⟺ its transport differs from the authenticated REST path (base URL/host, protocol, auth model) ├── weather: unauthenticated, outside /api → proxy ✓ └── streaming: WS + different host, but authenticated and session-coupled → stays a flat method (revisit on a 2nd streaming method) ``` ## Evidence - **Before:** no composition note; the weather-vs-flat split looks arbitrary (#151, first bullet). **After:** the rule is stated once, weather's proxy justified by it, streaming's deferral explicit. `pytest -q` → 242 passed, `mypy` → clean (docs-only change). ## Merge Danger **Door:** two-way **Blast Radius:** none — documentation only. Closes #175. Answers the first bullet of the #151 audit.
📝 docs: state the proxy-vs-mixin rule in the README
All checks were successful
Tests / forgejo-pytest (push) Successful in 44s
Tests / forgejo-pytest (pull_request) Successful in 44s
9105e263bd
mat changed title from WIP: 📝 docs: state the proxy-vs-mixin rule in the README to 📝 docs: state the proxy-vs-mixin rule in the README 2026-10-27 14:31:34 +00:00
mat merged commit 1369dde2f5 into main 2026-10-27 14:31:36 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
mat/python-comwatt-client!190
No description provided.