openepd 6.25.0__py3-none-any.whl → 6.27.0__py3-none-any.whl

openepd/__version__.py

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

openepd/constants/__init__.py

@@ -0,0 +1,15 @@
+#
+#  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.
+#

openepd/constants/scope_phases.py

@@ -0,0 +1,168 @@
+#
+#  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.
+#
+__all__ = ["ScopePhases"]
+
+
+from enum import StrEnum
+
+from openepd.utils.functional import classproperty
+
+
+# noinspection PyMethodParameters
+class ScopePhases(StrEnum):
+    """Container of common way to specify known scope phases under OpenEPD standard."""
+
+    A1 = "A1"
+    A2 = "A2"
+    A3 = "A3"
+    A1A2A3 = "A1A2A3"
+    A4 = "A4"
+    A5 = "A5"
+
+    B1 = "B1"
+    B2 = "B2"
+    B3 = "B3"
+    B4 = "B4"
+    B5 = "B5"
+    B6 = "B6"
+    B7 = "B7"
+
+    C1 = "C1"
+    C2 = "C2"
+    C3 = "C3"
+    C4 = "C4"
+
+    D = "D"
+
+    @classproperty
+    def a1a2a3(cls) -> str:
+        return cls.A1A2A3.lower()
+
+    @classproperty
+    def a1(cls) -> str:
+        return cls.A1.lower()
+
+    @classproperty
+    def a2(cls) -> str:
+        return cls.A2.lower()
+
+    @classproperty
+    def a3(cls) -> str:
+        return cls.A3.lower()
+
+    @classproperty
+    def a4(cls) -> str:
+        return cls.A4.lower()
+
+    @classproperty
+    def a5(cls) -> str:
+        return cls.A5.lower()
+
+    @classproperty
+    def b1(cls) -> str:
+        return cls.B1.lower()
+
+    @classproperty
+    def b2(cls) -> str:
+        return cls.B2.lower()
+
+    @classproperty
+    def b3(cls) -> str:
+        return cls.B3.lower()
+
+    @classproperty
+    def b4(cls) -> str:
+        return cls.B4.lower()
+
+    @classproperty
+    def b5(cls) -> str:
+        return cls.B5.lower()
+
+    @classproperty
+    def b6(cls) -> str:
+        return cls.B6.lower()
+
+    @classproperty
+    def b7(cls) -> str:
+        return cls.B7.lower()
+
+    @classproperty
+    def c1(cls) -> str:
+        return cls.C1.lower()
+
+    @classproperty
+    def c2(cls) -> str:
+        return cls.C2.lower()
+
+    @classproperty
+    def c3(cls) -> str:
+        return cls.C3.lower()
+
+    @classproperty
+    def c4(cls) -> str:
+        return cls.C4.lower()
+
+    @classproperty
+    def d(cls) -> str:
+        return cls.D.lower()
+
+    @classmethod
+    def a_scopes(cls, *, lowercase: bool = False) -> tuple[str, ...]:
+        result = (ScopePhases.A1A2A3, ScopePhases.A1, ScopePhases.A2, ScopePhases.A3, ScopePhases.A4, ScopePhases.A5)
+        if lowercase:
+            return cls._lowercase(result)
+        return result
+
+    @classmethod
+    def b_scopes(cls, *, lowercase: bool = False) -> tuple[str, ...]:
+        result = (
+            ScopePhases.B1,
+            ScopePhases.B2,
+            ScopePhases.B3,
+            ScopePhases.B4,
+            ScopePhases.B5,
+            ScopePhases.B6,
+            ScopePhases.B7,
+        )
+        if lowercase:
+            return cls._lowercase(result)
+
+        return result
+
+    @classmethod
+    def c_scopes(cls, *, lowercase: bool = False) -> tuple[str, ...]:
+        result = (ScopePhases.C1, ScopePhases.C2, ScopePhases.C3, ScopePhases.C4)
+        if lowercase:
+            return cls._lowercase(result)
+        return result
+
+    @classmethod
+    def d_scopes(cls, *, lowercase: bool = False) -> tuple[str, ...]:
+        result = (ScopePhases.D,)
+        if lowercase:
+            return cls._lowercase(result)
+        return result
+
+    @classmethod
+    def all_scopes(cls, *, lowercase: bool = False) -> tuple[str, ...]:
+        result = cls.a_scopes() + cls.b_scopes() + cls.c_scopes() + cls.d_scopes()
+        if lowercase:
+            return cls._lowercase(result)
+        return result
+
+    @classmethod
+    def _lowercase(cls, scopes: tuple[str, ...]) -> tuple[str, ...]:
+        return tuple(scope.lower() for scope in scopes)

openepd/model/common.py

@@ -13,13 +13,24 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+from collections.abc import Callable, Generator
 from enum import StrEnum
+import re
 from typing import Annotated, Any
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.validation.numbers import RatioFloat
 
+DATA_URL_REGEX = r"^data:([-\w]+\/[-+\w.]+)?(;?\w+=[-\w]+)*(;base64)?,.*$"
+"""
+Regular expression pattern for matching Data URLs.
+
+A Data URL is a URI scheme that allows you to embed small data items inline 
+in web pages as if they were external resources.
+The pattern matches the following format: data:[<media-type>][;base64],<data>
+"""
+
 
 class Amount(BaseOpenEpdSchema):
     """A value-and-unit pairing for amounts that do not have an uncertainty."""
@@ -313,3 +324,15 @@ class EnumGroupingAware:
     def get_groupings(cls) -> list[list]:
         """Return logical groupings of the values."""
         return []
+
+
+class DataUrl(str):
+    @classmethod
+    def __get_validators__(cls) -> Generator[Callable[[str], str], None, None]:
+        def validator(v: str) -> str:
+            if re.compile(DATA_URL_REGEX).match(v):
+                return v
+            msg = "Value must be a valid dataUrl"
+            raise ValueError(msg)
+
+        yield validator

openepd/model/declaration.py

@@ -203,6 +203,9 @@ class WithVerifierMixin(pyd.BaseModel):
     third_party_verifier_email: pyd.EmailStr | None = pyd.Field(
         description="Email address of the third party verifier", example="john.doe@example.com", default=None
     )
+    third_party_verifier_name: str | None = pyd.Field(
+        description="The publishable name of the third party verifier", example="John Doe", default=None
+    )
 
 
 class WithEpdDeveloperMixin(pyd.BaseModel):

openepd/model/lcia.py

@@ -522,6 +522,7 @@ class LCIAMethod(StrEnum):
     CML_1992 = "CML 1992"
     RECIPE_2016 = "ReCiPe 2016"
     RECIPE_2008 = "ReCiPe 2008"
+    GWP_GHG = "GWP-GHG"
     LIME2 = "LIME2"
 
     @classmethod

openepd/model/org.py

@@ -13,15 +13,24 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from typing import Annotated, Optional
+import math
+from typing import Annotated, Final, Optional
 
 from openlocationcode import openlocationcode
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import Location, WithAltIdsMixin, WithAttachmentsMixin
+from openepd.model.common import DataUrl, Location, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.validation.common import ReferenceStr
 
+ORG_LOGO_MAX_LENGTH: Final[int] = math.ceil(32 * 1024 * 4 / 3)
+"""
+Maximum length of Org.logo field.
+
+Logo file size must be less than 32KB. Base64 encoding overhead (approximately 33%) requires 
+limiting the encoded string length to 4/3 of the file size limit.
+"""
+
 
 class OrgRef(BaseOpenEpdSchema):
     """Represents Organisation with minimal data."""
@@ -85,6 +94,21 @@ class Org(WithAttachmentsMixin, WithAltIdsMixin, OrgRef):
         default=None,
         description="Location of a place of business, preferably the corporate headquarters.",
     )
+    logo: pyd.AnyUrl | DataUrl | None = pyd.Field(
+        default=None,
+        description=(
+            "URL pointer to, or dataURL, for a square logo for the company, preferably 300x300 pixels."
+            "A logo of the type used on social media platforms such as LinkedIn is recommended."
+        ),
+        example="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
+    )
+
+    @pyd.validator("logo")
+    def validate_logo(cls, v: str | None) -> str | None:
+        if v and len(v) > ORG_LOGO_MAX_LENGTH:
+            msg = f"Logo URL must not exceed {ORG_LOGO_MAX_LENGTH} characters"
+            raise ValueError(msg)
+        return v
 
 
 class PlantRef(BaseOpenEpdSchema):

openepd/utils/functional.py

@@ -0,0 +1,36 @@
+#
+#  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.
+#
+
+# Portions of this file are sourced from https://github.com/django/django/blob/main/django/utils/functional.py
+# Copyright (c) Django Software Foundation and individual contributors.
+# Licensed under the BSD 3-Clause License.
+
+# noinspection PyPep8Naming
+class classproperty:
+    """
+    Decorator that converts a method with a single cls argument into a property
+    that can be accessed directly from the class.
+    """  # noqa: D205
+
+    def __init__(self, method=None):
+        self.fget = method
+
+    def __get__(self, instance, cls=None):
+        return self.fget(cls)
+
+    def getter(self, method):
+        self.fget = method
+        return self

{openepd-6.25.0.dist-info → openepd-6.27.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openepd
-Version: 6.25.0
+Version: 6.27.0
 Summary: Python library to work with OpenEPD format
 License: Apache-2.0
 Author: C-Change Labs

{openepd-6.25.0.dist-info → openepd-6.27.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=fhxfEyEurLvSfvQci-vb3njzl_lvhcLXiZrecCOaMU8,794
-openepd/__version__.py,sha256=hDgSAJf2ChxmeWlgYCHYlntPXqIh3A42Hhy4RbDRnLc,639
+openepd/__version__.py,sha256=HmKYYpYPt8TvWu0Hh2PXVwOFCv8fcayILaKwQX8TeWk,639
 openepd/api/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=_eZt_jGVL1a3p9cr-EF39Ve9Vl5sB8zwzTc_slnRL50,7975
@@ -38,21 +38,23 @@ openepd/bundle/writer.py,sha256=kX1vJ3z96W1TxYwy152hHbmHul_7jcxUXV8psOhtr18,8564
 openepd/compat/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/compat/compat_functional_validators.py,sha256=aWg3a80fqT8zjN0S260N-Ad2WFKAaB8ByN7ArBW3NMA,834
 openepd/compat/pydantic.py,sha256=HZJmAiYO7s-LLcFHuj3iXS4MGOITExZYn2rPmteoqNI,1146
+openepd/constants/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
+openepd/constants/scope_phases.py,sha256=zcK7ytSbCNE76tX0vZMWbEUAFgFSifXU9YG_s3vvMqw,4035
 openepd/m49/__init__.py,sha256=AApOMp9PJPMXZbPB4piedqKtgHE01mlj_MyF3kf519U,718
 openepd/m49/const.py,sha256=bkYu6J7dQNVb2-nNkjy97uMpt64vICX5o-PHr0lk_90,31833
 openepd/m49/utils.py,sha256=vQl0wMXtYS2b7NeLIWilDNUopq3MATmLnhEFcMYTeZA,7256
 openepd/model/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/model/base.py,sha256=6rP6r-7NwKC6JLFB24v2w4Z-_f_w6ZSNLte5zyj5o70,9928
 openepd/model/category.py,sha256=reeOVRDuZPYU77EMwG0K5VjnK2H9yOGxT0PJXXqrjEk,1639
-openepd/model/common.py,sha256=jblgVf_ASMelxe_-mk6fnOIyM4n0TY4PJ8MeLX8O92c,13134
-openepd/model/declaration.py,sha256=72oR19n0CfJx4DhMXGYrLYY_sUB4awZzpr4Tr3Jcnks,13814
+openepd/model/common.py,sha256=WM6ankkeZazVzKwbn4s5FHwENMTIKWsgdRJkX7DYmpg,13875
+openepd/model/declaration.py,sha256=1WXTRlSRIUXTJJhL_e7BkoFyZ9gJKZH7c8pFVxihGFU,13980
 openepd/model/epd.py,sha256=_1P9-etXfLAVmg44pglnBUvoEyQ50odNBsUrv_OeS9M,12308
 openepd/model/factory.py,sha256=UWSGpfCr3GiMTP4rzBkwqxzbXB6GKZ_5Okb1Dqa_4aA,2701
 openepd/model/generic_estimate.py,sha256=zLGTyf4Uzmp2C0m-J1ePWItSz2RGdZ0OiGPWC5nhKHk,3992
 openepd/model/geography.py,sha256=Jx7NIDdk_sIvwyh-7YxnIjAwIHW2HCQK7UtFGM2xKtw,42095
 openepd/model/industry_epd.py,sha256=QZr7OhgGkzqZ8H5p6dCIVk9zSHEYtK3y9Nk-DvkFMyk,4011
-openepd/model/lcia.py,sha256=5SkiFdJKtza2fc2BBuepbl0TAi-UYsjSDR0ERj9ffmk,26206
-openepd/model/org.py,sha256=AAyXx42phVn3fZN0_Ga8CJb2iKh_dfVXsvO1lEtDovM,6832
+openepd/model/lcia.py,sha256=PdaSZz02PMBJl_t2B_dmkcbzIFjA7iACrWj1fllHfw0,26230
+openepd/model/org.py,sha256=zxBt-c2f1nhJUqygUzhsq6AEEwfNiYGquhgYvcUfvSo,7771
 openepd/model/pcr.py,sha256=7nf6ATofdrlPt81vdU6p0E8n_ftFEuCEIKxtYlFwclw,5476
 openepd/model/specs/README.md,sha256=UGhSiFJ9hOxT1mZl-5ZrhkOrPKf1W_gcu5CI9hzV7LU,2430
 openepd/model/specs/__init__.py,sha256=toVWd8_jxmAf7gRwpoXQpLfZW6Cl-NwveoduMXhECms,3903
@@ -151,9 +153,10 @@ openepd/model/versioning.py,sha256=wBZdOVL3ND9FMIRU9PS3vx9M_7MBiO70xYPQvPez6po,4
 openepd/patch_pydantic.py,sha256=bO7U5HqthFol0vfycb0a42UAGL3KOQ8-9MW4yCWOFP0,4150
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openepd/utils/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
+openepd/utils/functional.py,sha256=sm7od2_UE-cNToezBlwFQ1TCUJub1tz6VykA1X8XH-I,1274
 openepd/utils/mapping/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/utils/mapping/common.py,sha256=WphCzwQQlzX11tUk88Ubyq3QPBLvH0tBPSIuH0kmiug,7339
-openepd-6.25.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.25.0.dist-info/METADATA,sha256=sXZ1WJU-4BzBy9ZSCjbmL_cvd_44recegC2mmALLGlE,9827
-openepd-6.25.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-openepd-6.25.0.dist-info/RECORD,,
+openepd-6.27.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.27.0.dist-info/METADATA,sha256=1qocBkldct5oXEPyBq3C6KN9M9OErubIul8X68L_M1U,9827
+openepd-6.27.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openepd-6.27.0.dist-info/RECORD,,