validibot-shared 0.1.0__py3-none-any.whl

validibot_shared-0.1.0.dist-info/METADATA

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: validibot-shared
+Version: 0.1.0
+Summary: Shared library for data interchange between Validibot and validator containers
+Project-URL: Homepage, https://validibot.com
+Project-URL: Documentation, https://docs.validibot.com
+Project-URL: Repository, https://github.com/danielmcquillen/validibot-shared
+Project-URL: Issues, https://github.com/danielmcquillen/validibot-shared/issues
+Author-email: Daniel McQuillen <daniel@validibot.com>
+Maintainer-email: Daniel McQuillen <daniel@validibot.com>
+License: MIT
+License-File: LICENSE
+License-File: NOTICE
+Keywords: data-interchange,energyplus,fmu,simulation,validation,validibot
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+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
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# validibot-shared
+
+Shared Pydantic models for [Validibot](https://validibot.com) validator containers.
+
+This library defines the data interchange types used between Validibot and its advanced validator services, ensuring type safety and contract consistency.
+
+## Installation
+
+```bash
+pip install validibot-shared
+```
+
+Or with uv:
+
+```bash
+uv add validibot-shared
+```
+
+## Package Structure
+
+```
+validibot_shared/
+├── validations/          # Base validation envelope schemas
+│   └── envelopes.py     # Input/output envelopes for all validators
+├── energyplus/          # EnergyPlus-specific models and envelopes
+│   ├── models.py        # Simulation output models
+│   └── envelopes.py     # Typed envelope subclasses
+└── fmi/                 # FMI/FMU-specific models
+    ├── models.py        # Probe result models
+    └── envelopes.py     # FMI envelope subclasses
+```
+
+## Core Concepts
+
+### Validation Envelopes
+
+The library provides base envelope classes for validator communication:
+
+- `ValidationInputEnvelope` - Standard input format for validation jobs
+- `ValidationOutputEnvelope` - Standard output format with results
+- `ValidationCallback` - Callback payload for async job completion
+
+Supporting classes include `InputFileItem`, `ValidatorInfo`, `ExecutionContext`, `ValidationMessage`, `ValidationMetric`, and `ValidationArtifact`.
+
+### Typed Subclassing Pattern
+
+Domain-specific validators extend the base envelopes with typed fields:
+
+```python
+from validibot_shared.energyplus import EnergyPlusInputEnvelope, EnergyPlusInputs
+
+# The envelope has typed inputs instead of dict[str, Any]
+envelope = EnergyPlusInputEnvelope(
+    run_id="abc-123",
+    inputs=EnergyPlusInputs(timestep_per_hour=4),
+    # ... other fields
+)
+
+# IDE autocomplete and type checking work
+timestep = envelope.inputs.timestep_per_hour
+```
+
+This provides:
+
+- **Type safety** - mypy/pyright catch errors at compile time
+- **Runtime validation** - Pydantic validates all data
+- **IDE support** - Full autocomplete for domain-specific fields
+
+## Usage Examples
+
+### Creating an Input Envelope
+
+```python
+from validibot_shared.energyplus import EnergyPlusInputEnvelope, EnergyPlusInputs
+from validibot_shared.validations.envelopes import (
+    InputFileItem,
+    ValidatorInfo,
+    ExecutionContext,
+)
+
+envelope = EnergyPlusInputEnvelope(
+    run_id="run-123",
+    validator=ValidatorInfo(id="v1", type="energyplus", version="24.2.0"),
+    input_files=[
+        InputFileItem(
+            name="model.idf",
+            mime_type="application/vnd.energyplus.idf",
+            role="primary-model",
+            uri="gs://bucket/model.idf",
+        ),
+    ],
+    inputs=EnergyPlusInputs(timestep_per_hour=4),
+    context=ExecutionContext(
+        callback_url="https://api.example.com/callback",
+        execution_bundle_uri="gs://bucket/run-123/",
+    ),
+)
+```
+
+### Deserializing Results
+
+```python
+from validibot_shared.energyplus import EnergyPlusOutputEnvelope
+
+# Parse JSON response from validator
+envelope = EnergyPlusOutputEnvelope.model_validate_json(response_json)
+
+# Access typed outputs
+if envelope.outputs:
+    print(f"EUI: {envelope.outputs.metrics.eui_kbtu_per_sqft}")
+```
+
+### FMI Probe Results
+
+```python
+from validibot_shared.fmi.models import FMIProbeResult, FMIVariableMeta
+
+# Create a successful probe result
+result = FMIProbeResult.success(
+    variables=[
+        FMIVariableMeta(name="temperature", causality="output", value_type="Real"),
+    ],
+    execution_seconds=0.5,
+)
+
+# Create a failure result
+result = FMIProbeResult.failure(errors=["Invalid FMU: missing modelDescription.xml"])
+```
+
+## Dependencies
+
+- `pydantic>=2.8.0`
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

validibot_shared-0.1.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+validibot_shared/__init__.py,sha256=ZecaJniQW7349MWfs6RZGWQwSRAnxZuXkidc-j3xp_8,447
+validibot_shared/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+validibot_shared/energyplus/__init__.py,sha256=PbrCDa9WEoky5_L6iqtlBHE2B1OYBGeTl3tTQu5YZSM,652
+validibot_shared/energyplus/envelopes.py,sha256=GreSRPiZzlJyDsUZfYqNWN-VbHzzLTEPEL4rkH11-I4,10629
+validibot_shared/energyplus/models.py,sha256=gAtJL6WJ9gNS1tM5tZu39kPi7PZDVEl0AWdfDRVjWb8,4713
+validibot_shared/fmi/__init__.py,sha256=ezn5KmwtCph5w0sZRHtZ_Odx-pseuLp_RLUf1lfnuK8,132
+validibot_shared/fmi/envelopes.py,sha256=H0HvGzZu11mHLZ8FW1hBlFf4RQUfkzolay63MCFbC1k,5468
+validibot_shared/fmi/models.py,sha256=iHYE_HtOGPtb77MJ8KTS4MuSBL5QA7h8FWxFAuy3Btg,1840
+validibot_shared/validations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+validibot_shared/validations/envelopes.py,sha256=QvLXHxYJniBxn3N3QUNfdUZoGrckeyBh6AvirE2F_0g,20006
+validibot_shared-0.1.0.dist-info/METADATA,sha256=8w_Koeuw2k6swbsdfqCk6LqxY4_noJr-8YGMq0XuIhs,5152
+validibot_shared-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+validibot_shared-0.1.0.dist-info/licenses/LICENSE,sha256=T123ZvRRmFe8WtQNa7b2TELu87bW4BZ-k9enaH-5u-k,1093
+validibot_shared-0.1.0.dist-info/licenses/NOTICE,sha256=gR4UbHXacA-Uey1tOAA0LsLC9Ca5UL-QK3oLT5fY-4k,782
+validibot_shared-0.1.0.dist-info/RECORD,,

validibot_shared-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

validibot_shared-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 McQuillen Interactive Pty. Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

validibot_shared-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1,23 @@
+Validibot Shared Library
+Copyright (c) 2024-2026 McQuillen Interactive Pty. Ltd.
+
+This product is licensed under the MIT License.
+See the LICENSE file for the full license text.
+
+TRADEMARKS
+
+"Validibot", the Validibot logo, and the Validibot robot character are
+trademarks of McQuillen Interactive Pty. Ltd. The MIT license grants rights
+to the source code only, not to the trademarks.
+
+You may use the Validibot name to accurately describe that your software
+uses or integrates with Validibot, but not in a way that suggests official
+endorsement or affiliation beyond that relationship.
+
+THIRD-PARTY COMPONENTS
+
+This software includes the following third-party components:
+
+- Pydantic (MIT License) - https://docs.pydantic.dev/
+
+Each component is subject to its own license terms.