Skip to content

Upgrade Python SDK for HVAKR API v0.6#10

Merged
daytonmux merged 4 commits into
masterfrom
daytonmux/upgrade-python-client-v060
Jul 14, 2026
Merged

Upgrade Python SDK for HVAKR API v0.6#10
daytonmux merged 4 commits into
masterfrom
daytonmux/upgrade-python-client-v060

Conversation

@daytonmux

@daytonmux daytonmux commented Jul 14, 2026

Copy link
Copy Markdown
Member

Upgrades the SDK package and schemas to the v0.6 modular equipment, mode-keyed airflow, and unified calculations contracts.

Replaces retired output, weather, and Revit client methods with paginated projects, jobs, products, identity, idempotency, SDK-version warnings, and updated documentation.

Adds focused sync/async API and schema coverage; pytest, Ruff, and strict mypy pass.

Note

Upgrade Python SDK to HVAKR API v0.6 with modular equipment configuration

  • Replaces the flat CentralUnitConfiguration/TerminalUnitConfiguration models with a modular EquipmentData structure using EquipmentComponent pipelines and per-mode ComponentConfiguration maps in project.py.
  • Adds new API schema models in api.py: APIJob/APIJobCreate for async jobs, APIProduct/ProductListResponse for the product catalog, and APIMe* models for the /me identity endpoint.
  • Adds APIProjectCalculations and supporting airflow/ventilation section models to outputs.py, replacing the old get_project_outputs method with get_project_calculations.
  • Updates both HVAKRClient and AsyncHVAKRClient in client.py to support paginated list_projects, idempotency keys on writes, new job/product/me endpoints, and a shared _ClientBase that appends X-HVAKR-Client headers and logs one-time server warnings.
  • Risk: Breaking changes — OutsideAirMethod values changed from integers to strings, many legacy fields (coolingCoil, heatingCoil, outsideAir, energyConfigurations, weather station methods, get_project_outputs) are removed and will no longer validate or deserialize.

Macroscope summarized f8e9667.

Comment thread src/hvakr/schemas/project.py
Comment thread src/hvakr/schemas/project.py
@daytonmux daytonmux merged commit 8705de0 into master Jul 14, 2026
1 check passed
@daytonmux daytonmux deleted the daytonmux/upgrade-python-client-v060 branch July 14, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant