openepd 7.7.0__py3-none-any.whl → 7.9.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 = "7.7.0"
+VERSION = "7.9.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

@@ -21,6 +21,15 @@ import pydantic_core
 
 from openepd.model.base import BaseOpenEpdSchema
 
+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."""

openepd/model/declaration.py

@@ -232,6 +232,9 @@ class WithVerifierMixin(pydantic.BaseModel):
         examples=["john.doe@example.com"],
         default=None,
     )
+    third_party_verifier_name: str | None = pydantic.Field(
+        description="The publishable name of the third party verifier", examples=["John Doe"], default=None
+    )
 
 
 class WithEpdDeveloperMixin(pydantic.BaseModel):

openepd/model/lcia.py

@@ -602,6 +602,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,16 +13,26 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from typing import Any, Optional
+import math
+import re
+from typing import Any, Final, Optional
 
 from openlocationcode import openlocationcode
 import pydantic
 from pydantic import ConfigDict
 
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import Location, WithAltIdsMixin, WithAttachmentsMixin
+from openepd.model.common import DATA_URL_REGEX, 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."""
@@ -121,6 +131,24 @@ class Org(WithAttachmentsMixin, WithAltIdsMixin, OrgRef):
         default=None,
         description="Location of a place of business, preferably the corporate headquarters.",
     )
+    logo: pydantic.AnyUrl | None = pydantic.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."
+        ),
+        examples=["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA", "https://example.com/logo.png"],
+    )
+
+    @pydantic.field_validator("logo")
+    def _validate_logo(cls, v: pydantic.AnyUrl | None) -> pydantic.AnyUrl | 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)
+        if v and v.scheme == "data" and not re.compile(DATA_URL_REGEX).match(str(v)):
+            msg = "Invalid data URL format"
+            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-7.7.0.dist-info → openepd-7.9.0.dist-info}/METADATA

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

{openepd-7.7.0.dist-info → openepd-7.9.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
-openepd/__version__.py,sha256=yl4wQF-1qgdO4jZxe2wV3xfKlACh5SDmznbBqByduEM,638
+openepd/__version__.py,sha256=xseAZdp78WQweRvIrAvEz2aklRo4lfHf3OIGYTXz70A,638
 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=mjTT8eGtfj6Fgp-wcs0cCWA7DJo1KL_iQ75rgKkaY3c,8037
@@ -35,21 +35,23 @@ openepd/bundle/base.py,sha256=2tv7KbxG9zC_nuMOGudorxZcTl5rU6ABJmEbO2WTPas,8400
 openepd/bundle/model.py,sha256=4pmOCgK-kdBu7_PLm5QhlrVZRmab_18o0EGvcUjI8FQ,2722
 openepd/bundle/reader.py,sha256=H1mfuFxV2G0q9ld0dJ6SRucTwcTSEi-sFoKJLsBk4IQ,7767
 openepd/bundle/writer.py,sha256=cyFikYTtZCcX0rhdpbuvOaOBG4CS1nE8JjHUdB7Wghs,8708
+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=lxp2bzwD4d95VHo5ULKFN8ryzjjfKTwpe9_MdUFIoXw,32104
 openepd/m49/utils.py,sha256=0UvdtC9gtvRA5WT_hJDIuQR0RSrnx-S34wwwBRM_tsM,7807
 openepd/model/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/model/base.py,sha256=4D8BaSoNeY8RZfjkmJOSyfg0B34dKzM76lZbQT9AIXg,13622
 openepd/model/category.py,sha256=iyzzAsiVwW4zJ61oYsm9Sy-sEBA71-aMFXcJP1Y-dPI,1734
-openepd/model/common.py,sha256=D-FmaKk_ay6Of3HdUiloagc2nUiOLp97781BDRZMp8U,14662
-openepd/model/declaration.py,sha256=v-X2JBOK-7ZYWziEUP7GOSrQFK4pI9EMZvp3Z7-mwwM,14669
+openepd/model/common.py,sha256=a4FFM5moxEyOTAQuf0eZTbWb3vz2deGh37j1nLg3f0k,15002
+openepd/model/declaration.py,sha256=n55PqeIsBGT4UGHjGyb92txuoPB_S0eZ3lcmUAuS4NQ,14843
 openepd/model/epd.py,sha256=FL8g-dKb4SaCF_xIrtVx21tmNoofARaxN-yp6_Vv_bY,12748
 openepd/model/factory.py,sha256=UWSGpfCr3GiMTP4rzBkwqxzbXB6GKZ_5Okb1Dqa_4aA,2701
 openepd/model/generic_estimate.py,sha256=_R18Uz-hvxtSBl53D0_OkwVCWvoa2nIDjBdec6vEPDE,4304
 openepd/model/geography.py,sha256=Jx7NIDdk_sIvwyh-7YxnIjAwIHW2HCQK7UtFGM2xKtw,42095
 openepd/model/industry_epd.py,sha256=Cqn01IUNSZqRkyU05TwtOLXDKlg0YnGzqvKL8A__zbI,4061
-openepd/model/lcia.py,sha256=IfSLZER6kI1tb0tKZW1FeHxFqeumznurELNLtYR6TC8,32756
-openepd/model/org.py,sha256=zYZXTwU5Xah-MAiG0dP8SNRACpb79TmTWF6mUoROk8M,8181
+openepd/model/lcia.py,sha256=6o6GNwLaQaWyYAXCnHl2aAgDa12_v7DwpME5BfVMezk,32780
+openepd/model/org.py,sha256=ij_GEFEShRh-k4o29gSowiaJbCuyNqWu61YL3BNq0FM,9369
 openepd/model/pcr.py,sha256=cu3EakCAjBCkcb_AaLXB-xEjY0mlG-wJe74zGc5tdS0,5637
 openepd/model/specs/README.md,sha256=UGhSiFJ9hOxT1mZl-5ZrhkOrPKf1W_gcu5CI9hzV7LU,2430
 openepd/model/specs/__init__.py,sha256=RMLxvwD-_N5qaU0U2o5LxMKmP_W0_yssl72uTTC2tJg,3904
@@ -147,11 +149,12 @@ openepd/model/validation/quantity.py,sha256=M9dz3byTK6Lrys43I0Gq7n2b0aE8WYys-idx
 openepd/model/versioning.py,sha256=QzPeWiRCNvSUmlXANg4Vl4WqsPtlrCr8gSwDNUhZGvM,4577
 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=hxfN-WW2WLwE_agQzf_mhvz6OHq5WWlr24uZ1S81k4Y,8426
 openepd/utils/mapping/geography.py,sha256=1_-dvLk11Hqn-K58yUI5pQ5X5gsnJPFlFT7JK2Rdoeg,2396
 openepd/utils/markdown.py,sha256=RQmudPhb4QU1I4-S-VV2WFbzzq2Po09kbpjjKbwkA9E,1830
-openepd-7.7.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-7.7.0.dist-info/METADATA,sha256=pyqC4h1XAG1lwB2uZQ82w2XAmgelS-7sqwGCVnsxYgg,9810
-openepd-7.7.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-openepd-7.7.0.dist-info/RECORD,,
+openepd-7.9.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-7.9.0.dist-info/METADATA,sha256=D8Gws6Rt5kgaiTC5ak0ti0H75NZW6qs__u0Lo0GpNSg,9810
+openepd-7.9.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openepd-7.9.0.dist-info/RECORD,,