openepd 6.26.0__py3-none-any.whl → 6.28.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.26.0"
+VERSION = "6.28.0"

openepd/api/epd/sync_api.py

@@ -13,6 +13,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+from collections.abc import Collection
 from typing import Literal, overload
 
 from requests import Response
@@ -27,15 +28,17 @@ from openepd.model.epd import Epd
 class EpdApi(BaseApiMethodGroup):
     """API methods for EPDs."""
 
-    def get_by_openxpd_uuid(self, uuid: str) -> Epd:
+    def get_by_openxpd_uuid(self, uuid: str, *, fields: Collection[str] | None = None) -> Epd:
         """
         Get EPD by OpenEPD UUID.
 
         :param uuid: OpenEPD UUID
-        :return: EPD
+        :param fields: Optional collection of field names to include in the response
+        :return: EPD, Response, or tuple of EPD and Response depending on return_type
         :raise ObjectNotFound: if EPD is not found
         """
-        content = self._client.do_request("get", f"/epds/{uuid}").json()
+        params = {"fields": ",".join(set(fields))} if fields else None
+        content = self._client.do_request("get", f"/epds/{uuid}", params=params).json()
         return Epd.parse_obj(content)
 
     def find_raw(self, omf: str, page_num: int = 1, page_size: int = 10) -> EpdSearchResponse:

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/epd.py

@@ -139,6 +139,7 @@ class EpdPreviewV0(
     WithEpdDeveloperMixin,
     WithVerifierMixin,
     WithAltIdsMixin,
+    EpdRef,
     BaseDeclaration,
     title="EPD (Preview)",
 ):

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-6.26.0.dist-info → openepd-6.28.0.dist-info}/METADATA

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

{openepd-6.26.0.dist-info → openepd-6.28.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=fhxfEyEurLvSfvQci-vb3njzl_lvhcLXiZrecCOaMU8,794
-openepd/__version__.py,sha256=QKzyjy31-5ATfvNMXjjiW14NUCNwqK2LRcIIk6cIt0s,639
+openepd/__version__.py,sha256=IUCrF_atrQRdHN3rso9BDfVu8IPQGot8f1SiPEB8L9Y,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
@@ -17,7 +17,7 @@ openepd/api/dto/mf.py,sha256=59YvIrH5teHlpxINihxryFyCjs7jBZZuqYIO1K-daA8,1994
 openepd/api/dto/params.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/epd/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/epd/dto.py,sha256=MqhHjaNdtOc-KT2zNI88EB9-1d2a6CS2zzSus8HefBo,4874
-openepd/api/epd/sync_api.py,sha256=kBsx43q0cBm51hl3HVvzMIDrMMRi8NMyudPmHYd0qqU,7342
+openepd/api/epd/sync_api.py,sha256=WD0Hq15oiEPyrE1uW8ta30sUjPcy7LMcPeo6uYfnilQ,7659
 openepd/api/errors.py,sha256=BgZeNfMNAKVPfhpuiVapCXNBSsXygAOWql-gy7m9j7E,2868
 openepd/api/org/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/org/sync_api.py,sha256=VzOrd3eB1xPVLyrKlZl3OwXIQ5nT3808sA6N7MNBu7w,3167
@@ -46,15 +46,15 @@ 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/common.py,sha256=WM6ankkeZazVzKwbn4s5FHwENMTIKWsgdRJkX7DYmpg,13875
 openepd/model/declaration.py,sha256=1WXTRlSRIUXTJJhL_e7BkoFyZ9gJKZH7c8pFVxihGFU,13980
-openepd/model/epd.py,sha256=_1P9-etXfLAVmg44pglnBUvoEyQ50odNBsUrv_OeS9M,12308
+openepd/model/epd.py,sha256=SGAgEEAuvRGsIlgIUI60UqV1alhb5kouOvp8fAC0VPg,12320
 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=PdaSZz02PMBJl_t2B_dmkcbzIFjA7iACrWj1fllHfw0,26230
-openepd/model/org.py,sha256=AAyXx42phVn3fZN0_Ga8CJb2iKh_dfVXsvO1lEtDovM,6832
+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
@@ -156,7 +156,7 @@ 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.26.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.26.0.dist-info/METADATA,sha256=jCPbtt_A2IWHV85XvL4yLOyvkxsz9xE4PYOF7KlPSpc,9827
-openepd-6.26.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-openepd-6.26.0.dist-info/RECORD,,
+openepd-6.28.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.28.0.dist-info/METADATA,sha256=Csp45UMu54luUAHWZ46DFe4gAYhvLt4m0J0lUikNfaY,9827
+openepd-6.28.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openepd-6.28.0.dist-info/RECORD,,