openepd 4.9.0__tar.gz → 4.10.0__tar.gz

{openepd-4.9.0 → openepd-4.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 4.9.0
+Version: 4.10.0
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0

{openepd-4.9.0 → openepd-4.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "4.9.0"
+version = "4.10.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]

{openepd-4.9.0 → openepd-4.10.0}/src/openepd/__version__.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-VERSION = "4.9.0"
+VERSION = "4.10.0"

{openepd-4.9.0 → openepd-4.10.0}/src/openepd/model/base.py

@@ -37,6 +37,7 @@ class OpenEpdDoctypes(StrEnum):
 
     Epd = "openEPD"
     GenericEstimate = "openGenericEstimate"
+    IndustryEpd = "openIndustryEpd"
 
 
 def modify_pydantic_schema(schema_dict: dict, cls: type) -> dict:

{openepd-4.9.0 → openepd-4.10.0}/src/openepd/model/declaration.py

@@ -17,10 +17,17 @@ import abc
 import datetime
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import RootDocument
+from openepd.model.base import BaseOpenEpdSchema, RootDocument
 from openepd.model.common import Amount
+from openepd.model.geography import Geography
+from openepd.model.org import Org
 from openepd.model.pcr import Pcr
 from openepd.model.standard import Standard
+from openepd.model.validation.common import ReferenceStr
+
+DEVELOPER_DESCRIPTION = "The organization responsible for the underlying LCA (and subsequent summarization as EPD)."
+PROGRAM_OPERATOR_DESCRIPTION = "JSON object for program operator Org"
+THIRD_PARTY_VERIFIER_DESCRIPTION = "JSON object for Org that performed a critical review of the EPD data"
 
 
 class BaseDeclaration(RootDocument, abc.ABC):
@@ -111,3 +118,75 @@ class BaseDeclaration(RootDocument, abc.ABC):
     In the absence of primary data, cleaning assumptions shall be documented.
     """,
     )
+
+
+class AverageDatasetMixin(pyd.BaseModel, title="Average Dataset"):
+    """Fields common for average dataset (Industry-wide EPDs, Generic Estimates)."""
+
+    description: str | None = pyd.Field(
+        max_length=2000,
+        description="1-paragraph description of the average dataset. Supports plain text or github flavored markdown.",
+    )
+
+    geography: list[Geography] | None = pyd.Field(
+        "Jurisdiction(s) in which the LCA result is applicable.  An empty array, or absent properties, implies global applicability."
+    )
+
+
+class WithProgramOperatorMixin(pyd.BaseModel):
+    """Object which has a connection to ProgramOperator."""
+
+    program_operator: Org | None = pyd.Field(description=PROGRAM_OPERATOR_DESCRIPTION)
+    program_operator_doc_id: str | None = pyd.Field(
+        max_length=200, description="Document identifier from Program Operator.", example="123-456.789/b"
+    )
+    program_operator_version: str | None = pyd.Field(
+        max_length=200, description="Document version number from Program Operator.", example="4.3.0"
+    )
+
+
+class WithVerifierMixin(pyd.BaseModel):
+    """Set of fields related to verifier."""
+
+    third_party_verifier: Org | None = pyd.Field(description=THIRD_PARTY_VERIFIER_DESCRIPTION)
+    third_party_verification_url: pyd.AnyUrl | None = pyd.Field(
+        description="Optional link to a verification statement.",
+        example="https://we-verify-epds.com/en/letters/123-456.789b.pdf",
+    )
+    third_party_verifier_email: pyd.EmailStr | None = pyd.Field(
+        description="Email address of the third party verifier", example="john.doe@example.com", default=None
+    )
+
+
+class WithEpdDeveloperMixin(pyd.BaseModel):
+    """Set of fields related to EPD Developer."""
+
+    epd_developer: Org | None = pyd.Field(
+        description=DEVELOPER_DESCRIPTION,
+        default=None,
+    )
+    epd_developer_email: pyd.EmailStr | None = pyd.Field(
+        default=None,
+        example="john.doe@we-do-lca.com",
+        description="Email contact for inquiries about development of this EPD. "
+        "This must be an email which can be publicly shared.",
+    )
+
+
+class RefBase(BaseOpenEpdSchema, title="Ref Object"):
+    """Base class for reference-style objects."""
+
+    id: str | None = pyd.Field(
+        description="The unique ID for this object. To ensure global uniqueness, should be registered at "
+        "open-xpd-uuid.cqd.io/register or a coordinating registry.",
+        example="1u7zsed8",
+        default=None,
+    )
+
+    name: str | None = pyd.Field(max_length=200, description="Name of the object", default=None)
+
+    ref: ReferenceStr | None = pyd.Field(
+        default=None,
+        example="https://openepd.buildingtransparency.org/api/generic_estimates/EC300001",
+        description="Reference to this JSON object",
+    )

{openepd-4.9.0 → openepd-4.10.0}/src/openepd/model/epd.py

@@ -18,7 +18,15 @@ from typing import Annotated
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
 from openepd.model.common import Amount, Ingredient, WithAltIdsMixin, WithAttachmentsMixin
-from openepd.model.declaration import BaseDeclaration
+from openepd.model.declaration import (
+    DEVELOPER_DESCRIPTION,
+    PROGRAM_OPERATOR_DESCRIPTION,
+    THIRD_PARTY_VERIFIER_DESCRIPTION,
+    BaseDeclaration,
+    WithEpdDeveloperMixin,
+    WithProgramOperatorMixin,
+    WithVerifierMixin,
+)
 from openepd.model.lcia import WithLciaMixin
 from openepd.model.org import Org, Plant
 from openepd.model.specs import Specs
@@ -27,12 +35,17 @@ from openepd.model.versioning import OpenEpdVersions, Version
 MANUFACTURER_DESCRIPTION = (
     'JSON object for declaring Org. Sometimes called the "Declaration Holder" or "Declaration Owner".'
 )
-DEVELOPER_DESCRIPTION = "The organization responsible for the underlying LCA (and subsequent summarization as EPD)."
-PROGRAM_OPERATOR_DESCRIPTION = "JSON object for program operator Org"
-THIRD_PARTY_VERIFIER_DESCRIPTION = "JSON object for Org that performed a critical review of the EPD data"
 
 
-class EpdPreviewV0(WithAttachmentsMixin, WithAltIdsMixin, BaseDeclaration, title="EPD (Preview)"):
+class EpdPreviewV0(
+    WithAttachmentsMixin,
+    WithProgramOperatorMixin,
+    WithEpdDeveloperMixin,
+    WithVerifierMixin,
+    WithAltIdsMixin,
+    BaseDeclaration,
+    title="EPD (Preview)",
+):
     """
     EPD preview, used in API list responses and where there is no need for a full object.
 
@@ -67,36 +80,11 @@ class EpdPreviewV0(WithAttachmentsMixin, WithAltIdsMixin, BaseDeclaration, title
         example="https://epd-online.com/EmbeddedEpdList/Download/6029",
     )
     manufacturer: Org | None = pyd.Field(description=MANUFACTURER_DESCRIPTION)
-    epd_developer: Org | None = pyd.Field(
-        description=DEVELOPER_DESCRIPTION,
-        default=None,
-    )
-    epd_developer_email: pyd.EmailStr | None = pyd.Field(
-        default=None,
-        example="john.doe@we-do-lca.com",
-        description="Email contact for inquiries about development of this EPD. "
-        "This must be an email which can be publicly shared.",
-    )
     plants: list[Plant] = pyd.Field(
         max_items=32,
         description="List of object(s) for one or more plant(s) that this declaration applies to.",
         default_factory=list,
     )
-    program_operator: Org | None = pyd.Field(description=PROGRAM_OPERATOR_DESCRIPTION)
-    program_operator_doc_id: str | None = pyd.Field(
-        max_length=200, description="Document identifier from Program Operator.", example="123-456.789/b"
-    )
-    program_operator_version: str | None = pyd.Field(
-        max_length=200, description="Document version number from Program Operator.", example="4.3.0"
-    )
-    third_party_verifier: Org | None = pyd.Field(description=THIRD_PARTY_VERIFIER_DESCRIPTION)
-    third_party_verification_url: pyd.AnyUrl | None = pyd.Field(
-        description="Optional link to a verification statement.",
-        example="https://we-verify-epds.com/en/letters/123-456.789b.pdf",
-    )
-    third_party_verifier_email: pyd.EmailStr | None = pyd.Field(
-        description="Email address of the third party verifier", example="john.doe@example.com", default=None
-    )
     kg_C_per_declared_unit: Amount | None = pyd.Field(
         default=None,
         description="Mass of elemental carbon, per declared unit, contained in the product itself at the manufacturing "

{openepd-4.9.0 → openepd-4.10.0}/src/openepd/model/factory.py

@@ -16,6 +16,7 @@
 from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes, RootDocument
 from openepd.model.epd import EpdFactory
 from openepd.model.generic_estimate import GenericEstimateFactory
+from openepd.model.industry_epd import IndustryEpdFactory
 
 
 class DocumentFactory:
@@ -24,6 +25,7 @@ class DocumentFactory:
     DOCTYPE_TO_FACTORY: dict[OpenEpdDoctypes, type[BaseDocumentFactory]] = {
         OpenEpdDoctypes.Epd: EpdFactory,
         OpenEpdDoctypes.GenericEstimate: GenericEstimateFactory,
+        OpenEpdDoctypes.IndustryEpd: IndustryEpdFactory,
     }
 
     @classmethod

{openepd-4.9.0 → openepd-4.10.0}/src/openepd/model/generic_estimate.py

@@ -16,13 +16,11 @@
 from enum import StrEnum
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import BaseDocumentFactory, BaseOpenEpdSchema, OpenEpdDoctypes
+from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
 from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
-from openepd.model.declaration import BaseDeclaration
-from openepd.model.geography import Geography
+from openepd.model.declaration import AverageDatasetMixin, BaseDeclaration, RefBase
 from openepd.model.lcia import WithLciaMixin
 from openepd.model.org import Org
-from openepd.model.validation.common import ReferenceStr
 from openepd.model.versioning import OpenEpdVersions, Version
 
 
@@ -47,27 +45,12 @@ class LicenseTerms(StrEnum):
     """
 
 
-class GenericEstimateRef(BaseOpenEpdSchema, title="Generic Estimate (Ref)"):
+class GenericEstimateRef(RefBase, title="Generic Estimate (Ref)"):
     """Reference (short) version of Generic Estimate object."""
 
-    id: str | None = pyd.Field(
-        description="The unique ID for this document.  To ensure global uniqueness, should be registered at "
-        "open-xpd-uuid.cqd.io/register or a coordinating registry.",
-        example="1u7zsed8",
-        default=None,
-    )
-
-    name: str | None = pyd.Field(max_length=200, description="Name of the generic estimate", default=None)
-
-    ref: ReferenceStr | None = pyd.Field(
-        default=None,
-        example="https://openepd.buildingtransparency.org/api/generic_estimates/EC300001",
-        description="Reference to this GenericEstimate JSON object",
-    )
-
 
 class GenericEstimatePreviewV0(
-    WithAttachmentsMixin, GenericEstimateRef, BaseDeclaration, title="Generic Estimate (preview)"
+    WithAttachmentsMixin, AverageDatasetMixin, GenericEstimateRef, BaseDeclaration, title="Generic Estimate (preview)"
 ):
     """
     Generic Estimate preview, used in API list responses and where there is no need for a full object.
@@ -80,20 +63,13 @@ class GenericEstimatePreviewV0(
         default="openGenericEstimate",
     )
 
-    description: str | None = pyd.Field(
-        max_length=2000,
-        description="1-paragraph description of the Generic Estimate. Supports plain text or github flavored markdown.",
-    )
-
     publisher: Org | None = pyd.Field(description="Organization that published the LCA results.")
+    reviewer: Org | None = pyd.Field(description="Org that performed a critical review of the LCA.")
     reviewer_email: pyd.EmailStr | None = pyd.Field(
         description="Email address of the third party verifier", example="john.doe@example.com", default=None
     )
-    reviewer: Org | None = pyd.Field(description="Org that performed a critical review of the LCA.")
+
     license_terms: LicenseTerms | None = pyd.Field(description="The license terms for use of the data.")
-    geography: list[Geography] | None = pyd.Field(
-        "Jurisdiction(s) in which the LCA result is applicable.  An empty array, or absent properties, implies global applicability."
-    )
     model_repository: pyd.AnyUrl | None = pyd.Field(
         default=None, description="A link to the shared git repository containing the LCA model used for this estimate."
     )
@@ -104,7 +80,7 @@ GenericEstimatePreview = GenericEstimatePreviewV0
 
 class GenericEstimateV0(GenericEstimatePreviewV0, WithLciaMixin, WithAltIdsMixin, title="Generic Estimate (Full)"):
     """
-    Represent a full Generic Estimate object.
+    Full Generic Estimate object.
 
     This is considered the most complete valid openEPD object for GenericEstimate. In addition to it, several related
     models are defined, either with fewer fields (to be used in APIs for list requests) or with more relaxed structure