validibot-shared 0.3.1__tar.gz → 0.4.2__tar.gz

{validibot_shared-0.3.1 → validibot_shared-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: validibot-shared
-Version: 0.3.1
+Version: 0.4.2
 Summary: Shared library for data interchange between Validibot and validator containers
 Project-URL: Homepage, https://validibot.com
 Project-URL: Documentation, https://docs.validibot.com
@@ -24,10 +24,10 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: pydantic>=2.8.0
+Requires-Dist: pydantic==2.12.3
 Provides-Extra: dev
-Requires-Dist: pytest>=8.3.0; extra == 'dev'
-Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Requires-Dist: pytest==9.0.2; extra == 'dev'
+Requires-Dist: ruff==0.14.8; extra == 'dev'
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -212,18 +212,32 @@ validibot_shared/
 ```python
 from validibot_shared.energyplus import EnergyPlusInputEnvelope, EnergyPlusInputs
 from validibot_shared.validations.envelopes import (
+    ExecutionContext,
     InputFileItem,
+    OrganizationInfo,
+    SupportedMimeType,
     ValidatorInfo,
-    ExecutionContext,
+    ValidatorType,
+    WorkflowInfo,
 )
 
 envelope = EnergyPlusInputEnvelope(
     run_id="run-123",
-    validator=ValidatorInfo(id="v1", type="energyplus", version="24.2.0"),
+    validator=ValidatorInfo(
+        id="v1",
+        type=ValidatorType.ENERGYPLUS,
+        version="24.2.0",
+    ),
+    org=OrganizationInfo(id="org-123", name="Example Org"),
+    workflow=WorkflowInfo(
+        id="workflow-456",
+        step_id="step-789",
+        step_name="EnergyPlus Simulation",
+    ),
     input_files=[
         InputFileItem(
             name="model.idf",
-            mime_type="application/vnd.energyplus.idf",
+            mime_type=SupportedMimeType.ENERGYPLUS_IDF,
             role="primary-model",
             uri="gs://bucket/model.idf",
         ),
@@ -243,15 +257,16 @@ json_payload = envelope.model_dump_json()
 
 ```python
 from validibot_shared.energyplus import EnergyPlusOutputEnvelope
+from validibot_shared.validations.envelopes import ValidationStatus
 
 # Parse JSON response from validator
 envelope = EnergyPlusOutputEnvelope.model_validate_json(response_json)
 
 # Check status
-if envelope.status == "success":
+if envelope.status == ValidationStatus.SUCCESS:
     # Access typed outputs with full autocomplete
     if envelope.outputs and envelope.outputs.metrics:
-        print(f"EUI: {envelope.outputs.metrics.eui_kbtu_per_sqft} kBtu/sqft")
+        print(f"EUI: {envelope.outputs.metrics.site_eui_kwh_m2} kWh/m²")
 
 # Iterate over validation messages
 for message in envelope.messages:
@@ -401,13 +416,10 @@ cd validibot-shared
 uv sync --extra dev
 
 # Run tests
-uv run pytest
+uv run python -m pytest
 
 # Run linter
 uv run ruff check .
-
-# Run type checker
-uv run mypy src/
 ```
 
 ## Trademarks

{validibot_shared-0.3.1 → validibot_shared-0.4.2}/README.md

@@ -180,18 +180,32 @@ validibot_shared/
 ```python
 from validibot_shared.energyplus import EnergyPlusInputEnvelope, EnergyPlusInputs
 from validibot_shared.validations.envelopes import (
+    ExecutionContext,
     InputFileItem,
+    OrganizationInfo,
+    SupportedMimeType,
     ValidatorInfo,
-    ExecutionContext,
+    ValidatorType,
+    WorkflowInfo,
 )
 
 envelope = EnergyPlusInputEnvelope(
     run_id="run-123",
-    validator=ValidatorInfo(id="v1", type="energyplus", version="24.2.0"),
+    validator=ValidatorInfo(
+        id="v1",
+        type=ValidatorType.ENERGYPLUS,
+        version="24.2.0",
+    ),
+    org=OrganizationInfo(id="org-123", name="Example Org"),
+    workflow=WorkflowInfo(
+        id="workflow-456",
+        step_id="step-789",
+        step_name="EnergyPlus Simulation",
+    ),
     input_files=[
         InputFileItem(
             name="model.idf",
-            mime_type="application/vnd.energyplus.idf",
+            mime_type=SupportedMimeType.ENERGYPLUS_IDF,
             role="primary-model",
             uri="gs://bucket/model.idf",
         ),
@@ -211,15 +225,16 @@ json_payload = envelope.model_dump_json()
 
 ```python
 from validibot_shared.energyplus import EnergyPlusOutputEnvelope
+from validibot_shared.validations.envelopes import ValidationStatus
 
 # Parse JSON response from validator
 envelope = EnergyPlusOutputEnvelope.model_validate_json(response_json)
 
 # Check status
-if envelope.status == "success":
+if envelope.status == ValidationStatus.SUCCESS:
     # Access typed outputs with full autocomplete
     if envelope.outputs and envelope.outputs.metrics:
-        print(f"EUI: {envelope.outputs.metrics.eui_kbtu_per_sqft} kBtu/sqft")
+        print(f"EUI: {envelope.outputs.metrics.site_eui_kwh_m2} kWh/m²")
 
 # Iterate over validation messages
 for message in envelope.messages:
@@ -369,13 +384,10 @@ cd validibot-shared
 uv sync --extra dev
 
 # Run tests
-uv run pytest
+uv run python -m pytest
 
 # Run linter
 uv run ruff check .
-
-# Run type checker
-uv run mypy src/
 ```
 
 ## Trademarks

{validibot_shared-0.3.1 → validibot_shared-0.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "validibot-shared"
-version = "0.3.1"
+version = "0.4.2"
 description = "Shared library for data interchange between Validibot and validator containers"
 readme = "README.md"
 license = { text = "MIT" }
@@ -32,15 +32,10 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Scientific/Engineering",
 ]
-dependencies = [
-    "pydantic>=2.8.0",
-]
+dependencies = ["pydantic==2.12.3"]
 
 [project.optional-dependencies]
-dev = [
-    "pytest>=8.3.0",
-    "ruff>=0.8.0",
-]
+dev = ["pytest==9.0.2", "ruff==0.14.8"]
 
 [project.urls]
 Homepage = "https://validibot.com"
@@ -52,12 +47,7 @@ Issues = "https://github.com/danielmcquillen/validibot-shared/issues"
 packages = ["validibot_shared"]
 
 [tool.hatch.build.targets.sdist]
-include = [
-    "/validibot_shared",
-    "/tests",
-    "/README.md",
-    "/LICENSE",
-]
+include = ["/validibot_shared", "/tests", "/README.md", "/LICENSE"]
 
 [tool.ruff]
 line-length = 88

{validibot_shared-0.3.1 → validibot_shared-0.4.2}/validibot_shared/energyplus/models.py

@@ -48,8 +48,8 @@ class EnergyPlusSimulationMetrics(BaseModel):
     Extracted EnergyPlus simulation metrics.
 
     These are the core output signals extracted from EnergyPlus simulation results.
-    Field names here must match the binding_config["key"] values in the EnergyPlus
-    provider catalog (see validibot/validations/providers/energyplus.py).
+    Field names here are the canonical EnergyPlus signal names expected by core
+    Validibot. The core Django app maps these names to SignalDefinition rows.
 
     The validator extracts these values from the EnergyPlus SQL database
     (eplusout.sql) and they become available as output signals for assertions.

{validibot_shared-0.3.1 → validibot_shared-0.4.2}/validibot_shared/fmu/envelopes.py

@@ -7,9 +7,9 @@ the contract between Django and the FMU validator container:
 - Input envelope: FMU URI plus resolved input values and simulation config
 - Output envelope: FMU outputs, metrics, messages, and artifacts
 
-Inputs/outputs are keyed by validator catalog slugs. Workflow authors cannot
-remap signals; bindings live on catalog entries (input_binding_path) and
-default to slug-name lookups.
+Inputs/outputs use native FMU variable names as declared in the FMU's
+modelDescription.xml (e.g. "h" or "Temperature"). The core Django app
+resolves these names when building the envelope and when ingesting results.
 """
 
 from __future__ import annotations
@@ -54,11 +54,14 @@ class FMUSimulationConfig(BaseModel):
 
 
 class FMUInputs(BaseModel):
-    """Resolved inputs plus simulation config, keyed by catalog slugs."""
+    """Resolved inputs plus simulation config, keyed by native FMU variable names."""
 
     input_values: dict[str, Any] = Field(
         default_factory=dict,
-        description="Input values keyed by catalog slugs.",
+        description=(
+            "Input values keyed by native FMU variable "
+            "names (from modelDescription.xml)."
+        ),
     )
     simulation: FMUSimulationConfig = Field(
         default_factory=FMUSimulationConfig,
@@ -67,17 +70,21 @@ class FMUInputs(BaseModel):
     output_variables: list[str] = Field(
         default_factory=list,
         description=(
-            "Catalog slugs to capture as outputs. Empty means all output slugs."
+            "Native FMU variable names to capture as outputs. "
+            "Empty means all output variables from modelDescription.xml."
         ),
     )
 
 
 class FMUOutputs(BaseModel):
-    """FMU execution results keyed by catalog slugs."""
+    """FMU execution results keyed by native FMU variable names."""
 
     output_values: dict[str, Any] = Field(
         default_factory=dict,
-        description="Output values keyed by catalog slugs.",
+        description=(
+            "Output values keyed by native FMU variable "
+            "names (from modelDescription.xml)."
+        ),
     )
     fmu_guid: str | None = Field(default=None, description="FMU GUID, if reported.")
     fmi_version: str | None = Field(default=None, description="FMI version.")
@@ -139,11 +146,12 @@ def build_fmu_input_envelope(
         step_id: Workflow step ID
         step_name: Optional step name
         fmu_uri: FMU storage URI (gs://... or local path in dev)
-        input_values: Resolved inputs keyed by catalog slug
+        input_values: Resolved inputs keyed by native FMU variable name
         callback_url: URL to POST callback
         execution_bundle_uri: Base URI/path for this run's files
         simulation: Optional FMUSimulationConfig
-        output_variables: Optional list of catalog slugs to capture (empty=all outputs)
+        output_variables: Optional list of native FMU variable
+            names to capture (empty=all outputs)
     """
 
     input_files = [

{validibot_shared-0.3.1 → validibot_shared-0.4.2}/validibot_shared/fmu/models.py

@@ -2,7 +2,8 @@
 FMU probe result models.
 
 These models define the contract for FMU probing operations - extracting
-metadata from modelDescription.xml to populate validator catalog entries.
+metadata from modelDescription.xml. Probe results feed into SignalDefinition
+rows in the core Django app.
 
 Probing is done in-process in the Django worker (not in containers) since
 it's just XML parsing with no FMU execution.