openepd 7.1.0__py3-none-any.whl → 7.3.0__py3-none-any.whl

openepd/model/specs/singular/finishes.py

@@ -17,10 +17,6 @@ import pydantic
 
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
 from openepd.model.specs.enums import (
-    AccessFlooringCoreMaterial,
-    AccessFlooringFinishMaterial,
-    AccessFlooringSeismicRating,
-    AccessFlooringStringers,
     AllFabrication,
     CarpetFormFactor,
     CarpetIntendedApplication,
@@ -44,13 +40,12 @@ from openepd.model.specs.enums import (
     WoodFlooringTimberSpecies,
 )
 from openepd.model.specs.singular.common import HasForestPracticesCertifiers
+from openepd.model.specs.singular.mixins.access_flooring_mixin import AccessFlooringMixin
 from openepd.model.validation.quantity import (
     AreaPerVolumeStr,
-    ForceNStr,
     GwpKgCo2eStr,
     LengthMmStr,
     LengthMStr,
-    PressureMPaStr,
     RFactorStr,
     YarnWeightStr,
     validate_quantity_ge_factory,
@@ -59,7 +54,7 @@ from openepd.model.validation.quantity import (
 )
 
 
-class AccessFlooringV1(BaseOpenEpdHierarchicalSpec):
+class AccessFlooringV1(BaseOpenEpdHierarchicalSpec, AccessFlooringMixin):
     """
     Elevated floor system built on top of concrete slab surface.
 
@@ -69,57 +64,6 @@ class AccessFlooringV1(BaseOpenEpdHierarchicalSpec):
 
     _EXT_VERSION = "1.0"
 
-    # Own fields:
-    core_material: AccessFlooringCoreMaterial | None = pydantic.Field(
-        default=None, description="", examples=["Cementitious"]
-    )
-    finish_material: AccessFlooringFinishMaterial | None = pydantic.Field(
-        default=None, description="", examples=["Linoleum"]
-    )
-    stringers: AccessFlooringStringers | None = pydantic.Field(default=None, description="", examples=["Standard"])
-    seismic_rating: AccessFlooringSeismicRating | None = pydantic.Field(
-        default=None, description="", examples=["Type 0"]
-    )
-    magnetically_attached_finish: bool | None = pydantic.Field(
-        default=None,
-        description="",
-        examples=[True],
-    )
-    permanent_finish: bool | None = pydantic.Field(
-        default=None,
-        description="",
-        examples=[True],
-    )
-    drylay: bool | None = pydantic.Field(
-        default=None,
-        description="",
-        examples=[True],
-    )
-    adjustable_height: bool | None = pydantic.Field(
-        default=None,
-        description="",
-        examples=[True],
-    )
-    fixed_height: bool | None = pydantic.Field(
-        default=None,
-        description="",
-        examples=[True],
-    )
-    finished_floor_height: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["1 m"])
-    panel_thickness: LengthMmStr | None = pydantic.Field(default=None, description="", examples=["1 m"])
-    concentrated_load: PressureMPaStr | None = pydantic.Field(default=None, description="", examples=["1 MPa"])
-    uniform_load: PressureMPaStr | None = pydantic.Field(default=None, description="", examples=["1 MPa"])
-    rolling_load_10_pass: ForceNStr | None = pydantic.Field(default=None, description="", examples=["1 N"])
-    rolling_load_10000_pass: ForceNStr | None = pydantic.Field(default=None, description="", examples=["1 N"])
-
-    @pydantic.field_validator("rolling_load_10_pass", mode="before", check_fields=False)
-    def _access_flooring_rolling_load_10_pass_is_quantity_validator(cls, value):
-        return validate_quantity_unit_factory("N")(cls, value)
-
-    @pydantic.field_validator("rolling_load_10000_pass", mode="before", check_fields=False)
-    def _access_flooring_rolling_load_10000_pass_is_quantity_validator(cls, value):
-        return validate_quantity_unit_factory("N")(cls, value)
-
 
 class CarpetV1(BaseOpenEpdHierarchicalSpec):
     """Textile Floor Coverings."""
@@ -419,7 +363,7 @@ class BackingAndUnderlayV1(BaseOpenEpdHierarchicalSpec):
 class CementBoardV1(BaseOpenEpdHierarchicalSpec):
     """Hard cementitious boards, typically used as a tile backer."""
 
-    _EXT_VERSION = "1.0"
+    _EXT_VERSION = "1.1"
 
     # Own fields:
     thickness: CementBoardThickness | None = pydantic.Field(

openepd/model/specs/singular/manufacturing_inputs.py

@@ -28,6 +28,7 @@ from openepd.model.specs.enums import (
     MasonryCementAstmC91Type,
     TextilesFabricType,
 )
+from openepd.model.specs.singular.mixins.access_flooring_mixin import AccessFlooringMixin
 
 
 class CementV1(BaseOpenEpdHierarchicalSpec):
@@ -141,6 +142,16 @@ class TextilesV1(BaseOpenEpdHierarchicalSpec):
     fabric_type: list[TextilesFabricType] | None = pydantic.Field(default=None, description="", examples=[["Leather"]])
 
 
+class AccessFlooringPanelsV1(BaseOpenEpdHierarchicalSpec, AccessFlooringMixin):
+    """
+    Part of an access floor system.
+
+    Panels are laid on top of an access floor pedestal, creating a finish floor.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
 class ManufacturingInputsV1(BaseOpenEpdHierarchicalSpec):
     """
     Manufacturing inputs.
@@ -149,7 +160,7 @@ class ManufacturingInputsV1(BaseOpenEpdHierarchicalSpec):
     a construction.
     """
 
-    _EXT_VERSION = "1.0"
+    _EXT_VERSION = "1.1"
 
     # Nested specs:
     AccessFlooringPedestals: AccessFlooringPedestalsV1 | None = None
@@ -158,3 +169,4 @@ class ManufacturingInputsV1(BaseOpenEpdHierarchicalSpec):
     CementitiousMaterials: CementitiousMaterialsV1 | None = None
     ConcreteAdmixtures: ConcreteAdmixturesV1 | None = None
     Textiles: TextilesV1 | None = None
+    AccessFlooringPanels: AccessFlooringPanelsV1 | None = None

openepd/model/specs/singular/mixins/access_flooring_mixin.py

@@ -0,0 +1,55 @@
+#
+#  Copyright 2025 by C Change Labs Inc. www.c-change-labs.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+import pydantic as pyd
+
+from openepd.model.specs.base import BaseOpenEpdSpec
+from openepd.model.specs.enums import (
+    AccessFlooringCoreMaterial,
+    AccessFlooringFinishMaterial,
+    AccessFlooringSeismicRating,
+    AccessFlooringStringers,
+)
+from openepd.model.validation.quantity import ForceNStr, LengthMmStr, PressureMPaStr, validate_quantity_unit_factory
+
+
+class AccessFlooringMixin(BaseOpenEpdSpec):
+    core_material: AccessFlooringCoreMaterial | None = pyd.Field(
+        default=None, description="", examples=["Cementitious"]
+    )
+    finish_material: AccessFlooringFinishMaterial | None = pyd.Field(
+        default=None, description="", examples=["Linoleum"]
+    )
+    stringers: AccessFlooringStringers | None = pyd.Field(default=None, description="", examples=["Standard"])
+    seismic_rating: AccessFlooringSeismicRating | None = pyd.Field(default=None, description="", examples=["Type 0"])
+    magnetically_attached_finish: bool | None = pyd.Field(default=None, description="", examples=[True])
+    permanent_finish: bool | None = pyd.Field(default=None, description="", examples=[True])
+    drylay: bool | None = pyd.Field(default=None, description="", examples=[True])
+    adjustable_height: bool | None = pyd.Field(default=None, description="", examples=[True])
+    fixed_height: bool | None = pyd.Field(default=None, description="", examples=[True])
+    finished_floor_height: LengthMmStr | None = pyd.Field(default=None, description="", examples=["1 m"])
+    panel_thickness: LengthMmStr | None = pyd.Field(default=None, description="", examples=["1 m"])
+    concentrated_load: PressureMPaStr | None = pyd.Field(default=None, description="", examples=["1 MPa"])
+    uniform_load: PressureMPaStr | None = pyd.Field(default=None, description="", examples=["1 MPa"])
+    rolling_load_10_pass: ForceNStr | None = pyd.Field(default=None, description="", examples=["1 N"])
+    rolling_load_10000_pass: ForceNStr | None = pyd.Field(default=None, description="", examples=["1 N"])
+
+    @pyd.field_validator("rolling_load_10_pass", mode="before", check_fields=False)
+    def _access_flooring_rolling_load_10_pass_is_quantity_validator(cls, value):
+        return validate_quantity_unit_factory("N")(cls, value)
+
+    @pyd.field_validator("rolling_load_10000_pass", mode="before", check_fields=False)
+    def _access_flooring_rolling_load_10000_pass_is_quantity_validator(cls, value):
+        return validate_quantity_unit_factory("N")(cls, value)

openepd/model/specs/singular/steel.py

@@ -89,7 +89,8 @@ class HotRolledSectionsV1(BaseOpenEpdHierarchicalSpec, SteelFabricatedMixin):
 
 
 class PlateSteelV1(BaseOpenEpdHierarchicalSpec, SteelFabricatedMixin):
-    """Plate Steels.
+    """
+    Plate Steels.
 
     Flat hot-rolled steel, typically thicker than 'sheet', made by compressing multiple steel
     layers together into one.
@@ -260,10 +261,16 @@ class OtherSteelV1(BaseOpenEpdHierarchicalSpec):
     _EXT_VERSION = "1.0"
 
 
+class CrudeSteelV1(BaseOpenEpdHierarchicalSpec):
+    """Steel ingots, billets, blooms, and slabs for use in manufacturing steel products."""
+
+    _EXT_VERSION = "1.0"
+
+
 class SteelV1(BaseOpenEpdHierarchicalSpec):
     """Broad category for construction materials made from steel and its alloys."""
 
-    _EXT_VERSION = "1.1"
+    _EXT_VERSION = "1.2"
 
     # Own fields:
     yield_tensile_str: PressureMPaStr | None = pydantic.Field(
@@ -327,3 +334,4 @@ class SteelV1(BaseOpenEpdHierarchicalSpec):
     RebarSteel: RebarSteelV1 | None = None
     WireMeshSteel: WireMeshSteelV1 | None = None
     OtherSteel: OtherSteelV1 | None = None
+    CrudeSteel: CrudeSteelV1 | None = None

openepd/model/validation/common.py

@@ -13,7 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from typing import Annotated, Any, Callable, Type, TypeAlias
+from collections.abc import Callable
+from typing import Annotated, Any, TypeAlias
 
 import pydantic
 
@@ -25,7 +26,8 @@ def together_validator(field1: str, field2: Any, values: dict[str, Any]) -> Any:
     value1 = values.get(field1)
     value2 = values.get(field2)
     if value1 is not None and value2 is None or value1 is None and value2 is not None:
-        raise ValueError(f"Both or neither {field1} and {field2} days must be provided together")
+        msg = f"Both or neither {field1} and {field2} days must be provided together"
+        raise ValueError(msg)
 
 
 def validate_version_format(v: str) -> str:
@@ -36,17 +38,19 @@ def validate_version_format(v: str) -> str:
 
 def validate_version_compatibility(
     class_version_attribute_name: str,
-) -> Callable[[Type, str], str]:
+) -> Callable[[type, str], str]:
     """Ensure that the object which is passed for parsing and validation is compatible with the class."""
 
     # we need closure to pass property name, since actual class will only be available in runtime
-    def internal_validate_version_compatibility(cls: Type, v: str) -> str:
+    def internal_validate_version_compatibility(cls: type, v: str) -> str:
         if not hasattr(cls, class_version_attribute_name):
-            raise ValueError(f"Class {cls} must declare a class var extension var named {class_version_attribute_name}")
+            msg = f"Class {cls} must declare a class var extension var named {class_version_attribute_name}"
+            raise ValueError(msg)
 
         class_version = getattr(cls, class_version_attribute_name)
         if Version.parse_version(v).major != Version.parse_version(class_version).major:
-            raise ValueError(f"Extension version {v} does not match class version {class_version}")
+            msg = f"Extension version {v} does not match class version {class_version}"
+            raise ValueError(msg)
         return v
 
     return internal_validate_version_compatibility

openepd/model/validation/enum.py

@@ -13,7 +13,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from typing import Any, Callable
+from collections.abc import Callable
+from typing import Any
 
 from openepd.model.common import EnumGroupingAware
 
@@ -35,7 +36,8 @@ def exclusive_groups_validator_factory(enum_type: type[EnumGroupingAware]) -> Ca
         for grouping in enum_type.get_groupings():
             matching_from_group = [v for v in (value or []) if v in grouping]
             if len(matching_from_group) > 1:
-                raise ValueError(f"Values {', '.join(matching_from_group)} are not allowed together.")
+                msg = f"Values {', '.join(matching_from_group)} are not allowed together."
+                raise ValueError(msg)
 
         return value
 

openepd/model/validation/quantity.py

@@ -14,12 +14,12 @@
 #  limitations under the License.
 #
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any, Callable, ClassVar
+from collections.abc import Callable
+from typing import TYPE_CHECKING, Any, ClassVar, Self
 
 import pydantic
 from pydantic import ConfigDict
 import pydantic_core
-from typing_extensions import Self
 
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.common import Amount, OpenEPDUnit, RangeAmount
@@ -59,8 +59,10 @@ class QuantityValidator(ABC):
             dimensionality: The dimensionality to validate against, like "kg"
         Returns:
             None if the value is valid, raises an error otherwise.
+
         Raises:
             ValueError: If the value is not valid.
+
         """
         pass
 
@@ -74,8 +76,10 @@ class QuantityValidator(ABC):
             min_value: The value to compare with, like "102.4 kg"
         Returns:
             None if the value is valid, raises an error otherwise.
+
         Raises:
             ValueError: If the value is not valid.
+
         """
         pass
 
@@ -89,8 +93,10 @@ class QuantityValidator(ABC):
             max_value: The value to compare with, like "0.4 kg"
         Returns:
             None if the value is valid, raises an error otherwise.
+
         Raises:
             ValueError: If the value is not valid.
+
         """
         pass
 
@@ -168,10 +174,10 @@ class QuantityStr(str):
     unit: ClassVar[str]
 
     @classmethod
-    def _validate(cls, value: str) -> str:
+    def _validate(cls, value: str) -> Self:
         value = validate_quantity_unit_factory(cls.unit)(cls, value)
         value = validate_quantity_ge_factory(f"0 {cls.unit}")(cls, value)
-        return value
+        return cls(value)
 
     @classmethod
     def __get_pydantic_core_schema__(
@@ -389,7 +395,8 @@ class WithDimensionalityMixin(BaseOpenEpdSchema):
             return self
 
         if self.unit is None:
-            raise ValueError("`unit` is required for dimensionality-validated amounts")
+            msg = "`unit` is required for dimensionality-validated amounts"
+            raise ValueError(msg)
 
         validate_unit_factory(self.dimensionality_unit)(BaseOpenEpdSchema, self.unit)
         return self
@@ -490,7 +497,7 @@ class WithPressureMpaMixin(WithDimensionalityMixin):
 
 
 class AmountPressureMpa(Amount, WithPressureMpaMixin):
-    """Length (mm)."""
+    """Pressure (MPa)."""
 
     pass
 

openepd/model/versioning.py

@@ -44,7 +44,8 @@ class Version(NamedTuple):
 
     @staticmethod
     def parse_version(version: str | None) -> "Version":
-        """Parse the version of extension or the format.
+        """
+        Parse the version of extension or the format.
 
         Version is expected to be major.minor
 
@@ -56,9 +57,11 @@ class Version(NamedTuple):
         else:
             splits = []
         if len(splits) != 2:
-            raise ValueError(f"Invalid version: {version}")
+            msg = f"Invalid version: {version}"
+            raise ValueError(msg)
         if not splits[0].isdigit() or not splits[1].isdigit():
-            raise ValueError(f"Invalid version: {version}")
+            msg = f"Invalid version: {version}"
+            raise ValueError(msg)
         return Version(major=int(splits[0]), minor=int(splits[1]))
 
     def __str__(self) -> str:
@@ -115,9 +118,8 @@ class OpenEpdVersions(Version, ReprEnum):
         for x in cls:
             if x.value.major == branch:
                 return x.value
-        raise ValueError(
-            f"No version {branch}.x is not supported. Supported versions are: {', '.join(str(x.value) for x in cls)}"
-        )
+        msg = f"No version {branch}.x is not supported. Supported versions are: {', '.join(str(x.value) for x in cls)}"
+        raise ValueError(msg)
 
     @classmethod
     def get_current(cls) -> Version:

{openepd-7.1.0.dist-info → openepd-7.3.0.dist-info}/METADATA

@@ -1,15 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: openepd
-Version: 7.1.0
+Version: 7.3.0
 Summary: Python library to work with OpenEPD format
-Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0
 Author: C-Change Labs
 Author-email: support@c-change-labs.com
 Maintainer: C-Change Labs
 Maintainer-email: open-source@c-change-labs.com
 Requires-Python: >=3.11,<4.0
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -21,7 +20,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: api-client
 Requires-Dist: email-validator (>=1.3.1)
 Requires-Dist: idna (>=3.7)
-Requires-Dist: open-xpd-uuid (>=0.2.1,<0.3.0)
+Requires-Dist: open-xpd-uuid (>=0.2.1,<2)
 Requires-Dist: openlocationcode (>=1.0.1)
 Requires-Dist: pydantic (>=2.0,<3)
 Requires-Dist: requests (>=2.0) ; extra == "api-client"
@@ -45,6 +44,24 @@ Description-Content-Type: text/markdown
 
 This library is a Python library to work with OpenEPD format.
 
+> ⚠️ **Version Warning**
+>
+> This application is currently developed in **two major versions** in parallel:
+>
+> - **v6.x (>=6.0.0)** — Stable and production-ready. Maintains support for Pydantic v1 and v2 through a compatibility layer.
+> - **v7.x (>=7.0.0)** — Public beta. Fully functional, with native support for Pydantic v2. Still experimental and may introduce breaking changes in **internal and integration interfaces**.
+>
+> ⚠️ No breaking changes are expected in the **public standard or data model**, only in internal APIs and integration points.
+> 
+> Both versions currently offer the same set of features.  
+> We recommend using **v6** for most production use cases as the more mature and stable option.  
+> **v7** is suitable for production environments that can tolerate some level of interface instability and want to adopt the latest internals.
+>
+> 💡 Only the **latest version of v7** is guaranteed to contain all the features and updates from v6. Earlier v7 releases may lack some recent improvements.
+>
+> Once **v7 is promoted to stable**, all earlier **pre-stable (beta) v7 releases** will be **marked as yanked** to prevent accidental usage in production.
+>
+
 ## About OpenEPD
 
 [openEPD](https://www.buildingtransparency.org/programs/openepd/) is an open data format for passing digital
@@ -60,17 +77,10 @@ including uniqueness of organizations/plants, precise PCR references, and dated
 The openEPD format is **extensible**. Standard extensions exist for concrete products, and for
 documenting supply-chain specific data.
 
-[Read More about OpenEPD format here](https://www.buildingtransparency.org/programs/openepd/).
+[Read More about OpenEPD format here](https://www.open-epd-forum.org).
 
 ## Usage
 
-**❗ ATTENTION**: Pick the right version. The cornerstone of this library models package representing openEPD models.
-Models are defined with Pydantic library which is a dependency for openepd package. If you use Pydantic in your project
-carefully pick the version:
-
-* Use version **below** `2.0.0` if your project uses Pydantic version below `2.0.0`
-* Use version `2.x.x` or higher if your project uses Pydantic version `2.0.0` or above
-
 ### Models
 
 The library provides the Pydantic models for all the OpenEPD entities. The models are available in the `openepd.models`