openepd 6.3.0__tar.gz → 6.4.0__tar.gz

{openepd-6.3.0 → openepd-6.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 6.3.0
+Version: 6.4.0
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0
@@ -20,6 +20,7 @@ Provides-Extra: api-client
 Requires-Dist: email-validator (>=1.3.1)
 Requires-Dist: idna (>=3.7)
 Requires-Dist: open-xpd-uuid (>=0.2.1,<0.3.0)
+Requires-Dist: openlocationcode (>=1.0.1)
 Requires-Dist: pydantic (>=1.10,<3.0)
 Requires-Dist: requests (>=2.0) ; extra == "api-client"
 Project-URL: Repository, https://github.com/cchangelabs/openepd

{openepd-6.3.0 → openepd-6.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "6.3.0"
+version = "6.4.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]
@@ -26,6 +26,7 @@ email-validator = ">=1.3.1"
 requests = { version = ">=2.0", optional = true }
 idna = ">=3.7"
 open-xpd-uuid = "~=0.2.1"
+openlocationcode = ">=1.0.1"
 
 # Optional dependencies
 # lxml = { version = "~=4.9.2", optional = true }
@@ -140,3 +141,8 @@ exclude = ["test_.*\\.py$", ]
 module = []
 ignore_missing_imports = true
 follow_imports = "skip"
+
+
+[[tool.mypy.overrides]]
+module = "openlocationcode.*"
+ignore_missing_imports = true

{openepd-6.3.0 → openepd-6.4.0}/src/openepd/__version__.py

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

{openepd-6.3.0 → openepd-6.4.0}/src/openepd/model/declaration.py

@@ -84,7 +84,7 @@ class BaseDeclaration(RootDocument, abc.ABC):
         description="Language this document is captured in, as an ISO 639-1 code",
         example="en",
     )
-    private: bool = pyd.Field(
+    private: bool | None = pyd.Field(
         default=False,
         description="This document's author does not wish the contents published. "
         "Useful for draft, partial, or confidential declarations.  "

{openepd-6.3.0 → openepd-6.4.0}/src/openepd/model/epd.py

@@ -23,6 +23,7 @@ from openepd.model.declaration import (
     THIRD_PARTY_VERIFIER_DESCRIPTION,
     BaseDeclaration,
     OriginalDataFormat,
+    RefBase,
     WithEpdDeveloperMixin,
     WithProgramOperatorMixin,
     WithVerifierMixin,
@@ -120,6 +121,12 @@ class Ec3EpdExtension(BaseOpenEpdSchema):
     original_data_format: OriginalDataFormat | None = pyd.Field(default=None)
 
 
+class EpdRef(RefBase, title="EPD (Ref)"):
+    """Reference (short) version of EPD object."""
+
+    pass
+
+
 class EpdPreviewV0(
     WithAttachmentsMixin,
     WithProgramOperatorMixin,

{openepd-6.3.0 → openepd-6.4.0}/src/openepd/model/org.py

@@ -15,6 +15,8 @@
 #
 from typing import Annotated, 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
@@ -77,6 +79,12 @@ class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         deprecated="Pluscode field is deprecated. If users need a pluscode they can obtain it from "
         "`id` like this: `id.spit('.', maxsplit=1)[0]`",
     )
+    latitude: float | None = pyd.Field(
+        default=None, description="(deprecated) Latitude of the plant location. Use 'location' fields instead."
+    )
+    longitude: float | None = pyd.Field(
+        default=None, description="(deprecated) Longitude of the plant location. Use 'location' fields instead."
+    )
     owner: Org | None = pyd.Field(description="Organization that owns the plant", default=None)
     name: str | None = pyd.Field(
         max_length=200,
@@ -87,17 +95,32 @@ class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     address: str | None = pyd.Field(
         max_length=200,
         default=None,
-        description="Text address, preferably geocoded",
+        description="(deprecated) Text address, preferably geocoded. Use 'location' fields instead",
         example="1503 Orchard Hill Rd, LaGrange, GA 30240, United States",
     )
     contact_email: pyd.EmailStr | None = pyd.Field(
         description="Email contact", example="info@interface.com", default=None
     )
+    location: Location | None = pyd.Field(description="Location of the plant", default=None)
 
     @classmethod
     def get_asset_type(cls) -> str | None:
         """Return the asset type of this class (see BaseOpenEpdSchema.get_asset_type for details)."""
         return "org"
 
+    @pyd.validator("id")
+    def _validate_id(cls, v: str) -> str:
+        try:
+            pluscode, web_domain = v.split(".", maxsplit=1)
+        except ValueError as e:
+            raise ValueError("Incorrectly formed id: should be pluscode.owner_web_domain") from e
+
+        if not openlocationcode.isValid(pluscode):
+            raise ValueError("Incorrect pluscode for plant")
+
+        if not web_domain:
+            raise ValueError("Incorrect web_domain for plant")
+        return v
+
     class Config(BaseOpenEpdSchema.Config):
         allow_population_by_field_name = True