openepd 2.0.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

openepd/api/epd/dto.py

@@ -0,0 +1,121 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+from typing import TypeAlias
+
+from openepd.api.dto.base import BaseOpenEpdApiModel
+from openepd.api.dto.common import BaseMeta, OpenEpdApiResponse
+from openepd.api.dto.meta import PagingMetaMixin, WarningMetaMixin
+from openepd.api.dto.mf import MaterialFilterMetaMixin
+from openepd.compat.pydantic import pyd
+from openepd.model.common import Amount
+from openepd.model.epd import Epd
+
+
+class StatisticsDto(BaseOpenEpdApiModel):
+    """
+    DTO describes statistics of EPD.
+
+    Statistics contains aggregated parameters such as percentiles distributions of GWP and other parameters.
+    """
+
+    # percentiles
+    pct10_gwp: float = pyd.Field(
+        description="10th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    achievable_target: float = pyd.Field(
+        description="Achievable target. 20th percentile of GWP measured in kgCO2e per declared unit", example=445.65
+    )
+    pct30_gwp: float = pyd.Field(
+        description="30th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct40_gwp: float = pyd.Field(
+        description="40th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct50_gwp: float = pyd.Field(
+        description="50th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct60_gwp: float = pyd.Field(
+        description="60th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct70_gwp: float = pyd.Field(
+        description="70th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    conservative_estimate: float = pyd.Field(
+        description="Conservative estimate. 80th percentile of GWP per declared unit measured in kgCO2e",
+        example=640.778,
+    )
+    pct90_gwp: float = pyd.Field(
+        description="70th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+
+    # stats
+    average: float = pyd.Field(description="Average GWP in kgCO2e per declared unit", example=554.2)
+    min: float | None = pyd.Field(
+        description="Min GWP of returned results measured in kgCO2e per declared unit", example=998.3
+    )
+    max: float | None = pyd.Field(
+        description="Max GWP of returned results measured in kgCO2e per declared unit", example=120.0
+    )
+
+    # percentiles w/out burden of doubt
+    pct20_gwp_no_bod: float | None = pyd.Field(
+        description="20th percentile of GWP (kgCO2e per declared unit), no burden of doubt", example=120
+    )
+    pct40_gwp_no_bod: float | None = pyd.Field(
+        description="40th percentile of GWP (kgCO2e per declared unit), no burden of doubt", example=120
+    )
+    pct60_gwp_no_bod: float | None = pyd.Field(
+        description="60th percentile of GWP (kgCO2e per declared unit), no burden of doubt", example=120
+    )
+    pct80_gwp_no_bod: float | None = pyd.Field(
+        description="80th percentile of GWP (kgCO2e per declared unit), no burden of doubt", example=120
+    )
+    average_gwp_no_bod: float | None = pyd.Field(description="Average GWP, no burden of doubt", example=120)
+
+    # set parameters
+    standard_deviation: float = pyd.Field(description="Standard deviation", example=87.62)
+    epds_count: int = pyd.Field(description="Number of EPDs participated in statistics", example=55)
+    industry_epds_count: int = pyd.Field(
+        description="Number of Industry-wide EPDs participated in statistics", example=4
+    )
+    generic_estimates_count: int = pyd.Field(
+        description="Number of Generic Estimates participated in statistics", example=0
+    )
+
+    declared_unit: Amount = pyd.Field(
+        description="Declared unit for the statistics. "
+        "Statistical values - percentiles, averages etc - are based on this unit of product"
+    )
+
+
+class EpdSearchMeta(MaterialFilterMetaMixin, PagingMetaMixin, WarningMetaMixin, BaseMeta):
+    """Metadata for EPD Search endpoint."""
+
+    pass
+
+
+class EpdStatisticsMeta(MaterialFilterMetaMixin, WarningMetaMixin, BaseMeta):
+    """Metadata for EPD Statistics endpoint."""
+
+    pass
+
+
+EpdSearchResponse: TypeAlias = OpenEpdApiResponse[list[Epd], EpdSearchMeta]
+EpdStatisticsResponse: TypeAlias = OpenEpdApiResponse[StatisticsDto, EpdStatisticsMeta]

openepd/api/epd/sync_api.py

@@ -0,0 +1,105 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+from openepd.api.base_sync_client import BaseApiMethodGroup
+from openepd.api.common import StreamingListResponse
+from openepd.api.epd.dto import EpdSearchResponse, EpdStatisticsResponse, StatisticsDto
+from openepd.model.epd import Epd
+
+
+class EpdApi(BaseApiMethodGroup):
+    """API methods for EPDs."""
+
+    def get_by_openxpd_uuid(self, uuid: str) -> Epd:
+        """
+        Get EPD by OpenEPD UUID.
+
+        :param uuid: OpenEPD UUID
+        :return: EPD
+        :raise ObjectNotFound: if EPD is not found
+        """
+        content = self._client.do_request("get", f"/epds/{uuid}").json()
+        return Epd.parse_obj(content)
+
+    def find_raw(self, omf: str, page_num: int = 1, page_size: int = 10) -> EpdSearchResponse:
+        """
+        Find EPDs by Open Material Filter(OMF).
+
+        OMF is a query language for searching materials/EPDs, running statistics and so on.
+        It can exist in a string form, which is accepted by most of the endpoints.
+
+        :param omf: OMF - open material filter string (see OMF spec).
+        :param page_num: page number
+        :param page_size: page size
+        :return: the list of EPDs
+        """
+        content = self._client.do_request(
+            "get",
+            "/v2/epds/search",
+            params=dict(
+                omf=omf,
+                page_number=page_num,
+                page_size=page_size,
+            ),
+        ).json()
+        return EpdSearchResponse.parse_obj(content)
+
+    def find(self, omf: str, page_size: int | None = None) -> StreamingListResponse[Epd]:
+        """
+        Find EPDs by Open Material Filter(OMF).
+
+        OMF is a query language for searching materials/EPDs, running statistics and so on.
+        It can exist in a string form, which is accepted by most of the endpoints.
+
+        :param omf: OMF - open material filter string (see OMF spec).
+        :param page_size: page size, None for default
+        :return: streaming list of EPDs
+        """
+
+        def _get_page(p_num: int, p_size: int) -> EpdSearchResponse:
+            return self.find_raw(omf, page_num=p_num, page_size=p_size)
+
+        return StreamingListResponse[Epd](_get_page, page_size=page_size)
+
+    def get_statistics_raw(self, omf: str) -> EpdStatisticsResponse:
+        """
+        Get statistics for a given search query.
+
+        Statistics contains aggregated parameters such as percentiles distributions of GWP and other parameters.
+        Please note - in addition to product EPDs statistics might include industry-wide EPDs and even generic
+        estimates to provide a more complete picture where there is not enough product EPDs.
+
+        :param omf: OMF - open material filter string (see OMF spec).
+        :return: statistics wrapped in OpenEpdApiResponse
+        """
+        content = self._client.do_request("get", "/v2/epds/statistics", params=dict(omf=omf)).json()
+        return EpdStatisticsResponse.parse_obj(content)
+
+    def get_statistics(self, omf: str) -> StatisticsDto:
+        """
+        Get statistics for a given search query.
+
+        Statistics contains aggregated parameters such as percentiles distributions of GWP and other parameters.
+        Please note - in addition to product EPDs statistics might include industry-wide EPDs and even generic
+        estimates to provide a more complete picture where there is not enough product EPDs.
+
+        :param omf: OMF - open material filter string (see OMF spec).
+        :return: statistics wrapped in OpenEpdApiResponse
+        """
+        return self.get_statistics_raw(omf).payload

openepd/api/errors.py

@@ -0,0 +1,86 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+from typing import Any
+
+
+class ApiError(Exception):
+    """Base class for all API errors."""
+
+    def __init__(
+        self, http_status: int, error_summary: str, response: Any = None, error_code: str | None = None
+    ) -> None:
+        super().__init__(error_summary)
+        self.error_summary = error_summary
+        self.http_status = http_status
+        self.error_code = error_code
+        self.response = response
+
+
+class ObjectNotFound(ApiError):
+    """Object not found error."""
+
+    pass
+
+
+class ServerError(ApiError):
+    """Server error."""
+
+    pass
+
+
+class ValidationError(ApiError):
+    """Validation error."""
+
+    def __init__(
+        self,
+        http_status: int,
+        error_summary: str,
+        validation_errors: dict[str, list[str]] | None,
+        response: Any,
+        error_code: str | None,
+    ) -> None:
+        super().__init__(http_status, error_summary, response, error_code)
+        self.validation_errors: dict[str, list[str]] = validation_errors or {}
+
+    def __str__(self) -> str:
+        result: list[str] = ["Validation errors:"]
+        for code, errors in self.validation_errors.items():
+            result.append(f"{code}:")
+            for e in errors:
+                result.append(f"  {e}")
+        return "\n".join(result)
+
+
+class AuthError(ApiError):
+    """Common class for any authentication related errors."""
+
+    pass
+
+
+class NotAuthorizedError(AuthError):
+    """Not authorized error."""
+
+    pass
+
+
+class AccessDeniedError(AuthError):
+    """Access denied error."""
+
+    pass

openepd/api/pcr/__init__.py

@@ -0,0 +1,19 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#

openepd/api/pcr/dto.py

@@ -0,0 +1,41 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+from openepd.api.dto.base import BaseOpenEpdApiModel
+from openepd.compat.pydantic import pyd
+
+
+class PcrRef(BaseOpenEpdApiModel):
+    """Reference to a PCR."""
+
+    id: str | None = pyd.Field(
+        description="The unique ID for this PCR.  To ensure global uniqueness, should be registered "
+        "at open-xpd-uuid.cqd.io/register or a coordinating registry.",
+        example="ec3xpgq2",
+        default=None,
+    )
+    name: str | None = pyd.Field(
+        max_length=200,
+        description="Full document name as listed in source document",
+        example="c-PCR-003 Concrete and concrete elements (EN 16757)",
+    )
+    ref: pyd.AnyUrl | None = pyd.Field(
+        description="Reference to this PCR's JSON object",
+        example="https://openepd.buildingtransparency.org/api/pcrs/1u7zsed8",
+    )

openepd/api/pcr/sync_api.py

@@ -0,0 +1,49 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+from openepd.api.base_sync_client import BaseApiMethodGroup
+from openepd.api.pcr.dto import PcrRef
+from openepd.model.pcr import Pcr
+
+
+class PcrApi(BaseApiMethodGroup):
+    """API methods for EPDs."""
+
+    def get_by_openxpd_uuid(self, uuid: str) -> Pcr:
+        """
+        Get PCR by Open xPD UUID.
+
+        :param uuid: Open xPD UUID
+        :return: PCR
+        :raise ObjectNotFound: if PCR not found
+        :raise ValidationError: if openxpd_uuid is invalid
+        """
+        content = self._client.do_request("get", f"/pcrs/{uuid}").json()
+        return Pcr.parse_obj(content)
+
+    def create(self, pcr: Pcr) -> PcrRef:
+        """
+        Create a new PCR.
+
+        :param pcr: PCR to create
+        :return: reference to the created PCR
+        :raise ValidationError: if given object PCR is invalid
+        """
+        pcr_ref_obj = self._client.do_request("post", "/pcrs", json=pcr.to_serializable()).json()
+        return PcrRef.parse_obj(pcr_ref_obj)

openepd/api/sync_client.py

@@ -0,0 +1,67 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+__all__ = ("OpenEpdApiClientSync",)
+
+from requests.auth import AuthBase
+
+from openepd.api.base_sync_client import SyncHttpClient, TokenAuth
+from openepd.api.category.sync_api import CategoryApi
+from openepd.api.epd.sync_api import EpdApi
+from openepd.api.pcr.sync_api import PcrApi
+
+
+class OpenEpdApiClientSync:
+    """Synchronous API client for OpenEPD."""
+
+    def __init__(self, base_url: str, auth_token: str | None, **kwargs) -> None:
+        """
+        Construct an API client.
+
+        :param base_url: base URL of the API
+        :param auth_token: authentication token
+        :param kwargs: additional arguments to pass to the HTTP client. See SyncHttpClient constructor for details.
+        """
+        super().__init__()
+        auth: AuthBase | None = TokenAuth(auth_token) if auth_token is not None else None
+        self._http_client = SyncHttpClient(base_url, auth=auth, **kwargs)
+        self.__epd_api: EpdApi | None = None
+        self.__pcr_api: PcrApi | None = None
+        self.__category_api: CategoryApi | None = None
+
+    @property
+    def epds(self) -> EpdApi:
+        """Get the EPD API."""
+        if self.__epd_api is None:
+            self.__epd_api = EpdApi(self._http_client)
+        return self.__epd_api
+
+    @property
+    def pcrs(self) -> PcrApi:
+        """Get the PCR API."""
+        if self.__pcr_api is None:
+            self.__pcr_api = PcrApi(self._http_client)
+        return self.__pcr_api
+
+    @property
+    def categories(self) -> CategoryApi:
+        """Get the Category API."""
+        if self.__category_api is None:
+            self.__category_api = CategoryApi(self._http_client)
+        return self.__category_api

openepd/api/test/__init__.py

@@ -0,0 +1,19 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#

openepd/bundle/__init__.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 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.

openepd/bundle/base.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 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.

openepd/bundle/model.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 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.
@@ -19,8 +19,7 @@
 #
 from enum import StrEnum
 
-import pydantic as pyd
-
+from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
 
 
@@ -77,10 +76,10 @@ class AssetInfo(BaseOpenEpdSchema):
     """The name of the asset."""
     type: AssetType
     """The type of the asset."""
-    lang: str | None = None
+    lang: str | None
     """The language of the asset."""
-    rel_type: str | None = None
-    rel_asset: str | None = None
+    rel_type: str | None
+    rel_asset: str | None
     comment: str | None = pyd.Field(default=None)
     content_type: str | None = pyd.Field(default=None)
     size: int | None = pyd.Field(default=None)

openepd/bundle/reader.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 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.
@@ -35,7 +35,7 @@ class DefaultBundleReader(BaseBundleReader):
         self._bundle_archive = zipfile.ZipFile(bundle_file, mode="r")
         try:
             with self._bundle_archive.open("manifest", "r") as manifest_stream:
-                self.__manifest = BundleManifest.model_validate_json(manifest_stream.read())
+                self.__manifest = BundleManifest.parse_raw(manifest_stream.read())
         except Exception as e:
             raise ValueError("The bundle file is not valid. Manifest reading error: " + str(e)) from e
         try:
@@ -49,7 +49,7 @@ class DefaultBundleReader(BaseBundleReader):
 
     def get_manifest(self) -> BundleManifest:
         """Get the manifest of the bundle. Manifest object is immutable."""
-        return self.__manifest.model_copy(deep=True)
+        return self.__manifest.copy(deep=True)
 
     def __create_asset_filter(
         self,
@@ -86,7 +86,7 @@ class DefaultBundleReader(BaseBundleReader):
         with self._bundle_archive.open("toc", "r") as toc_stream:
             toc_reader = csv.DictReader(io.TextIOWrapper(toc_stream, encoding="utf-8"), dialect="toc")
             for x in toc_reader:
-                yield AssetInfo.model_validate(self.__preprocess_csv_dict(x))
+                yield AssetInfo.parse_obj(self.__preprocess_csv_dict(x))
 
     def __check_toc(self):
         with self._bundle_archive.open("toc", "r") as toc_stream:
@@ -158,4 +158,4 @@ class DefaultBundleReader(BaseBundleReader):
         if asset.type != obj_class.get_asset_type():
             raise ValueError(f"Asset type mismatch. Expected {obj_class.get_asset_type()}, got {asset.type}")
         with self._bundle_archive.open(asset.ref, "r") as asset_stream:
-            return obj_class.model_validate_json(asset_stream.read())
+            return obj_class.parse_raw(asset_stream.read())

openepd/bundle/writer.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 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.
@@ -117,7 +117,8 @@ class DefaultBundleWriter(BaseBundleWriter):
             custom_data=custom_data,
         )
         self.__write_data_stream(
-            asset_info, BytesIO(obj.model_dump_json(indent=2, exclude_unset=True, exclude_none=True).encode("utf-8"))
+            asset_info,
+            BytesIO(obj.json(indent=2, exclude_unset=True, exclude_none=True, by_alias=True).encode("utf-8")),
         )
         self.__register_entry(asset_info)
         return asset_info
@@ -125,7 +126,7 @@ class DefaultBundleWriter(BaseBundleWriter):
     def commit(self):
         """Write the manifest and TOC to the bundle. This will be called automatically when the bundle is closed."""
         with self._bundle_archive.open("manifest", "w") as manifest_stream:
-            manifest_stream.write(self.__manifest.model_dump_json(indent=2, exclude_none=True).encode("utf-8"))
+            manifest_stream.write(self.__manifest.json(indent=2, exclude_none=True).encode("utf-8"))
         with self._bundle_archive.open("toc", "w") as toc_stream:
             toc_stream.write(self.__toc_buffer.getvalue().encode("utf-8"))
 
@@ -137,7 +138,7 @@ class DefaultBundleWriter(BaseBundleWriter):
     def __register_entry(self, asset_info: AssetInfo):
         if asset_info.ref in self.__added_entries:
             raise ValueError(f"Asset {asset_info.ref} already exists in the bundle.")
-        self._toc_writer.writerow(asset_info.model_dump(mode="json", exclude_unset=True, exclude_none=True))
+        self._toc_writer.writerow(asset_info.dict(exclude_unset=True, exclude_none=True))
         self.__added_entries.add(asset_info.ref)
         type_counter = self.__manifest.assets.count_by_type.get(asset_info.type, 0) + 1
         self.__manifest.assets.count_by_type[asset_info.type] = type_counter

openepd/compat/__init__.py

@@ -0,0 +1,19 @@
+#
+#  Copyright 2024 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#