openepd 6.19.0__py3-none-any.whl → 6.20.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.19.0"
+VERSION = "6.20.0"

openepd/api/org/__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/api/org/sync_api.py

@@ -0,0 +1,79 @@
+#
+#  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.
+#
+from typing import Literal, overload
+
+from requests import Response
+
+from openepd.api.base_sync_client import BaseApiMethodGroup
+from openepd.api.utils import encode_path_param
+from openepd.model.org import Org, OrgRef
+
+
+class OrgApi(BaseApiMethodGroup):
+    """API methods for Orgs."""
+
+    @overload
+    def create(self, to_create: Org, with_response: Literal[True]) -> tuple[OrgRef, Response]: ...
+
+    @overload
+    def create(self, to_create: Org, with_response: Literal[False] = False) -> OrgRef: ...
+
+    def create(self, to_create: Org, with_response: bool = False) -> OrgRef | tuple[OrgRef, Response]:
+        """
+        Create a new organization.
+
+        :param to_create: Organization to create
+        :param with_response: if True, return a tuple of (OrgRef, Response), otherwise return only OrgRef
+        :return: Organization reference or Organization reference with HTTP Response object depending on parameter
+        :raise ValidationError: if given object Org is invalid
+        """
+        response = self._client.do_request("post", "/orgs", json=to_create.to_serializable())
+        content = response.json()
+        ref = OrgRef.parse_obj(content)
+        if with_response:
+            return ref, response
+        return ref
+
+    @overload
+    def edit(self, to_edit: Org, with_response: Literal[True]) -> tuple[OrgRef, Response]: ...
+
+    @overload
+    def edit(self, to_edit: Org, with_response: Literal[False] = False) -> OrgRef: ...
+
+    def edit(self, to_edit: Org, with_response: bool = False) -> OrgRef | tuple[OrgRef, Response]:
+        """
+        Edit an organization.
+
+        :param to_edit: Organization to edit
+        :param with_response: if True, return a tuple of (OrgRef, Response), otherwise return only Org
+        :return: Organization reference or Organization reference with HTTP Response object depending on parameter
+        :raise ValueError: if the organization web_domain is not set
+        """
+        entity_id = to_edit.web_domain
+        if not entity_id:
+            msg = "The organization web_domain must be set to edit an organization."
+            raise ValueError(msg)
+        response = self._client.do_request(
+            "put",
+            f"/orgs/{encode_path_param(entity_id)}",
+            json=to_edit.to_serializable(exclude_unset=True, exclude_defaults=True, by_alias=True),
+        )
+        response.raise_for_status()
+        content = response.json()
+        ref = OrgRef.parse_obj(content)
+        if with_response:
+            return ref, response
+        return ref

openepd/api/pcr/sync_api.py

@@ -13,7 +13,12 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+from typing import Literal, overload
+
+from requests import Response
+
 from openepd.api.base_sync_client import BaseApiMethodGroup
+from openepd.api.utils import encode_path_param
 from openepd.model.pcr import Pcr, PcrRef
 
 
@@ -42,3 +47,33 @@ class PcrApi(BaseApiMethodGroup):
         """
         pcr_ref_obj = self._client.do_request("post", "/pcrs", json=pcr.to_serializable()).json()
         return PcrRef.parse_obj(pcr_ref_obj)
+
+    @overload
+    def edit(self, to_edit: Pcr, with_response: Literal[True]) -> tuple[PcrRef, Response]: ...
+
+    @overload
+    def edit(self, to_edit: Pcr, with_response: Literal[False] = False) -> PcrRef: ...
+
+    def edit(self, to_edit: Pcr, with_response: bool = False) -> PcrRef | tuple[PcrRef, Response]:
+        """
+        Edit a pcr.
+
+        :param to_edit: Pcr to edit
+        :param with_response: if True, return a tuple of (PcrRef, Response), otherwise return only PcrRef
+        :return: Pcr reference or Pcr reference with HTTP Response object depending on parameter
+        :raise ValueError: if the pcr ID is not set
+        """
+        entity_id = to_edit.id
+        if not entity_id:
+            msg = "The pcr ID must be set to edit a pcr."
+            raise ValueError(msg)
+        response = self._client.do_request(
+            "put",
+            f"/pcrs/{encode_path_param(entity_id)}",
+            json=to_edit.to_serializable(exclude_unset=True, exclude_defaults=True, by_alias=True),
+        )
+        content = response.json()
+        ref = PcrRef.parse_obj(content)
+        if with_response:
+            return ref, response
+        return ref

openepd/api/plant/__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/api/plant/sync_api.py

@@ -0,0 +1,79 @@
+#
+#  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.
+#
+from typing import Literal, overload
+
+from requests import Response
+
+from openepd.api.base_sync_client import BaseApiMethodGroup
+from openepd.api.utils import encode_path_param
+from openepd.model.org import Plant, PlantRef
+
+
+class PlantApi(BaseApiMethodGroup):
+    """API methods for Plants."""
+
+    @overload
+    def create(self, to_create: Plant, with_response: Literal[True]) -> tuple[PlantRef, Response]: ...
+
+    @overload
+    def create(self, to_create: Plant, with_response: Literal[False] = False) -> PlantRef: ...
+
+    def create(self, to_create: Plant, with_response: bool = False) -> PlantRef | tuple[PlantRef, Response]:
+        """
+        Create a new plant.
+
+        :param to_create: Plant to create
+        :param with_response: if True, return a tuple of (PlantRef, Response), otherwise return only PlantRef
+        :return: Plant reference or Plant reference with HTTP Response object depending on parameter
+        :raise ValidationError: if given object Plant is invalid
+        """
+        response = self._client.do_request("post", "/plants", json=to_create.to_serializable())
+        content = response.json()
+        ref = PlantRef.parse_obj(content)
+        if with_response:
+            return ref, response
+        return ref
+
+    @overload
+    def edit(self, to_edit: Plant, with_response: Literal[True]) -> tuple[PlantRef, Response]: ...
+
+    @overload
+    def edit(self, to_edit: Plant, with_response: Literal[False] = False) -> PlantRef: ...
+
+    def edit(self, to_edit: Plant, with_response: bool = False) -> PlantRef | tuple[PlantRef, Response]:
+        """
+        Edit a plant.
+
+        :param to_edit: Plant to edit
+        :param with_response: if True, return a tuple of (PlantRef, Response), otherwise return only PlantRef
+        :return: Plant reference or Plant reference with HTTP Response object depending on parameter
+        :raise ValueError: if the plant ID is not set
+        """
+        entity_id = to_edit.id
+        if not entity_id:
+            msg = "The plant ID must be set to edit a plant."
+            raise ValueError(msg)
+        response = self._client.do_request(
+            "put",
+            f"/plants/{encode_path_param(entity_id)}",
+            json=to_edit.to_serializable(exclude_unset=True, exclude_defaults=True, by_alias=True),
+        )
+        response.raise_for_status()
+        content = response.json()
+        ref = PlantRef.parse_obj(content)
+        if with_response:
+            return ref, response
+        return ref

openepd/api/standard/__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/api/standard/sync_api.py

@@ -0,0 +1,79 @@
+#
+#  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.
+#
+from typing import Literal, overload
+
+from requests import Response
+
+from openepd.api.base_sync_client import BaseApiMethodGroup
+from openepd.api.utils import encode_path_param
+from openepd.model.standard import Standard, StandardRef
+
+
+class StandardApi(BaseApiMethodGroup):
+    """API methods for Standards."""
+
+    @overload
+    def create(self, to_create: Standard, with_response: Literal[True]) -> tuple[StandardRef, Response]: ...
+
+    @overload
+    def create(self, to_create: Standard, with_response: Literal[False] = False) -> StandardRef: ...
+
+    def create(self, to_create: Standard, with_response: bool = False) -> StandardRef | tuple[StandardRef, Response]:
+        """
+        Create a new standard.
+
+        :param to_create: Standard to create
+        :param with_response: if True, return a tuple of (StandardRef, Response), otherwise return only StandardRef
+        :return: Standard reference or Standard reference with HTTP Response object depending on parameter
+        :raise ValidationError: if given object Standard is invalid
+        """
+        response = self._client.do_request("post", "/standards", json=to_create.to_serializable())
+        content = response.json()
+        ref = StandardRef.parse_obj(content)
+        if with_response:
+            return ref, response
+        return ref
+
+    @overload
+    def edit(self, to_edit: Standard, with_response: Literal[True]) -> tuple[StandardRef, Response]: ...
+
+    @overload
+    def edit(self, to_edit: Standard, with_response: Literal[False] = False) -> StandardRef: ...
+
+    def edit(self, to_edit: Standard, with_response: bool = False) -> StandardRef | tuple[StandardRef, Response]:
+        """
+        Edit a standard.
+
+        :param to_edit: Standard to edit
+        :param with_response: if True, return a tuple of (StandardRef, Response), otherwise return only StandardRef
+        :return: Standard reference or Standard reference with HTTP Response object depending on parameter
+        :raise ValueError: if the standard short_name is not set
+        """
+        entity_id = to_edit.short_name
+        if not entity_id:
+            msg = "The standard short_name must be set to edit a standard."
+            raise ValueError(msg)
+        response = self._client.do_request(
+            "put",
+            f"/standards/{encode_path_param(entity_id)}",
+            json=to_edit.to_serializable(exclude_unset=True, exclude_defaults=True, by_alias=True),
+        )
+        response.raise_for_status()
+        content = response.json()
+        ref = StandardRef.parse_obj(content)
+        if with_response:
+            return ref, response
+        return ref

openepd/api/sync_client.py

@@ -22,7 +22,10 @@ from openepd.api.average_dataset.industry_epd_sync_api import IndustryEpdApi
 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.org.sync_api import OrgApi
 from openepd.api.pcr.sync_api import PcrApi
+from openepd.api.plant.sync_api import PlantApi
+from openepd.api.standard.sync_api import StandardApi
 
 
 class OpenEpdApiClientSync:
@@ -41,6 +44,9 @@ class OpenEpdApiClientSync:
         self._http_client = SyncHttpClient(base_url, auth=auth, **kwargs)
         self.__epd_api: EpdApi | None = None
         self.__pcr_api: PcrApi | None = None
+        self.__org_api: OrgApi | None = None
+        self.__plant_api: PlantApi | None = None
+        self.__standard_api: StandardApi | None = None
         self.__category_api: CategoryApi | None = None
         self.__generic_estimate_api: GenericEstimateApi | None = None
         self.__industry_epd_api: IndustryEpdApi | None = None
@@ -59,6 +65,27 @@ class OpenEpdApiClientSync:
             self.__pcr_api = PcrApi(self._http_client)
         return self.__pcr_api
 
+    @property
+    def orgs(self) -> OrgApi:
+        """Get the Org API."""
+        if self.__org_api is None:
+            self.__org_api = OrgApi(self._http_client)
+        return self.__org_api
+
+    @property
+    def plants(self) -> PlantApi:
+        """Get the Plant API."""
+        if self.__plant_api is None:
+            self.__plant_api = PlantApi(self._http_client)
+        return self.__plant_api
+
+    @property
+    def standards(self) -> StandardApi:
+        """Get the Standard API."""
+        if self.__standard_api is None:
+            self.__standard_api = StandardApi(self._http_client)
+        return self.__standard_api
+
     @property
     def categories(self) -> CategoryApi:
         """Get the Category API."""

{openepd-6.19.0.dist-info → openepd-6.20.0.dist-info}/METADATA

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

{openepd-6.19.0.dist-info → openepd-6.20.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=fhxfEyEurLvSfvQci-vb3njzl_lvhcLXiZrecCOaMU8,794
-openepd/__version__.py,sha256=3bpnsguYhHUBbEqDHO2zgvwFAf_zr5yjuOpqcce4MLo,639
+openepd/__version__.py,sha256=qqFv4TdG_QezASXat2Iyq25c6fS3PUY0MuIdqETulzQ,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
@@ -19,9 +19,15 @@ openepd/api/epd/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,6
 openepd/api/epd/dto.py,sha256=MqhHjaNdtOc-KT2zNI88EB9-1d2a6CS2zzSus8HefBo,4874
 openepd/api/epd/sync_api.py,sha256=kBsx43q0cBm51hl3HVvzMIDrMMRi8NMyudPmHYd0qqU,7342
 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
 openepd/api/pcr/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
-openepd/api/pcr/sync_api.py,sha256=MyBOlBqdJt35-fXk-Vr-RpiKUbN_XlilUwwFGvVROdQ,1557
-openepd/api/sync_client.py,sha256=reD_OXsaVOvUvnC-cyp5aq8sKSOH2Z8xmImxV2ClQIM,3105
+openepd/api/pcr/sync_api.py,sha256=JWiegxoSnD2JElYORp6QdkbO3jDNhrNKxJR6orsD1TI,2849
+openepd/api/plant/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
+openepd/api/plant/sync_api.py,sha256=cryGfKojyXV78RxIPRTGscWuLnkdgTNJAw9RkxrbZWI,3121
+openepd/api/standard/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
+openepd/api/standard/sync_api.py,sha256=Oj_Os3yBPk7y7hXDvQbzr-AyX-z2b82jzbN7AuiK3Go,3264
+openepd/api/sync_client.py,sha256=DiDSQU0kBd9gU17KrPUvo07pyLv15rGozuWXbkM1JzA,4037
 openepd/api/test/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/utils.py,sha256=xOU8ihC0eghsoaCFhC85PU4WYRwNxVEpfK3gzq4e9ik,2092
 openepd/bundle/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
@@ -144,7 +150,7 @@ openepd/model/validation/quantity.py,sha256=mP4gIkeOGZuHRhprsf_BX11Cic75NssYxOTk
 openepd/model/versioning.py,sha256=wBZdOVL3ND9FMIRU9PS3vx9M_7MBiO70xYPQvPez6po,4522
 openepd/patch_pydantic.py,sha256=bO7U5HqthFol0vfycb0a42UAGL3KOQ8-9MW4yCWOFP0,4150
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-6.19.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.19.0.dist-info/METADATA,sha256=odv3HP47b4WVhRfBXhEgRjAEsAwEuLo6OkpjYvWKgoY,9067
-openepd-6.19.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-openepd-6.19.0.dist-info/RECORD,,
+openepd-6.20.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.20.0.dist-info/METADATA,sha256=J0jlBV5Gco4ONtZm_cOAEIAKc06-ChlLrK6TJ_tiAwc,9067
+openepd-6.20.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openepd-6.20.0.dist-info/RECORD,,