openepd 6.6.0__tar.gz → 6.7.1__tar.gz

{openepd-6.6.0 → openepd-6.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 6.6.0
+Version: 6.7.1
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0

{openepd-6.6.0 → openepd-6.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "6.6.0"
+version = "6.7.1"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]

{openepd-6.6.0 → openepd-6.7.1}/src/openepd/__version__.py

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

{openepd-6.6.0 → openepd-6.7.1}/src/openepd/model/common.py

@@ -149,10 +149,55 @@ class Location(BaseOpenEpdSchema):
     )
 
 
+ATTACHMENT_KNOWN_KEYS: dict[str, str] = {
+    "OpenEPD": "A Product EPD in OpenEPD format",
+    "openEPD": "Equivalent to OpenEPD",
+    "ILCD_EPD": "A Product EPD in ILCD+EPD format.  An underscore is used in place of '+' for compatability purposes.",
+    "OpenIndustryEPD": "An Industry EPD in OpenEPD format",
+    "openIndustryEPD": "Equivalent to OpenIndustryEPD",
+    "LCA_Model": "An underlying LCA model from which one could replicate these EPD results, in LCA Commons 2.0 format",
+    "LCA_Report": "An underlying LCA report, in PDF or other document format",
+    "lca_software": "A url, optionally with an #anchor tag, pointing to the version of the software used, generally one provided by the software vendor. ",
+    "lca_dataset_reference": "A URL link to an lca dataset used in the analysis.  Multiple dataset references can be added by appending a number or string after _reference, e.g. lca_dataset_reference_3 or lca_dataset_reference_steel",
+    "EPD": "Environmental Product Declaration, verified by a third party, not in OpenEPD format.",
+    "IndustryEPD": "EPD for an industry, sector, or group of companies, not in OpenEPD format.",
+    "Datasheet": "A technical data sheet describing the product.",
+    "PCR": "Product Category Rules for EPD generation",
+    "Contact_Us": "A url to contact.  May be an email (mailto:) link.",
+    "URL": "A link to a relevant resource.  No particular format is specified.  Each URL should be uniquely named. ",
+    "VOC": "Volatile Organic Compound declaration",
+    "HPD": "Material Health Product Declaration",
+    "PEF": "Product Environmental Footprint (without 3rd party verification)",
+    "MSDS": "Material Safety Data Sheet",
+    "Developer": "Link to the website of the group who performed the LCA and/or prepared the EPD.",
+}
+
+
+class AttachmentDict(dict[str, pyd.AnyUrl]):
+    """Special form of dict for attachments."""
+
+    @classmethod
+    def __modify_schema__(cls, field_schema: dict[str, Any], field: pyd.fields.ModelField | None):
+        # This may be generalized later to combine, for example, enum descriptions and field descriptions to provide
+        # a better result.
+        field_description = field.field_info.description if field else ""
+        if field_description:
+            field_description = field_description.strip()
+            if not field_description.endswith("."):
+                field_description += "."
+            field_description += " "
+
+        field_schema["description"] = field_description + "Extra properties of string -> URL allowed."
+        field_schema["properties"] = {
+            k: {"type": "string", "format": "uri", "description": v} for k, v in ATTACHMENT_KNOWN_KEYS.items()
+        }
+        field_schema["additionalProperties"] = True
+
+
 class WithAttachmentsMixin(pyd.BaseModel):
     """Mixin for objects that can have attachments."""
 
-    attachments: dict[Annotated[str, pyd.Field(max_length=200)], pyd.AnyUrl] | None = pyd.Field(
+    attachments: AttachmentDict = pyd.Field(
         description="Dict of URLs relevant to this entry",
         example={
             "Contact Us": "https://www.c-change-labs.com/en/contact-us/",

{openepd-6.6.0 → openepd-6.7.1}/src/openepd/model/org.py

@@ -63,8 +63,8 @@ class Org(WithAttachmentsMixin, WithAltIdsMixin, OrgRef):
     )
 
 
-class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
-    """Represent a manufacturing plant."""
+class PlantRef(BaseOpenEpdSchema):
+    """Represents Plant with minimal data."""
 
     id: str | None = pyd.Field(
         description="Plus code (aka Open Location Code) of plant's location and "
@@ -72,6 +72,22 @@ class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         example="865P2W3V+3W.interface.com",
         default=None,
     )
+    name: str | None = pyd.Field(
+        max_length=200,
+        description="Manufacturer's name for plant. Recommended < 40 chars",
+        example="Dalton, GA",
+        default=None,
+    )
+    ref: ReferenceStr | None = pyd.Field(
+        default=None,
+        example="https://openepd.buildingtransparency.org/api/orgs/c-change-labs.com",
+        description="Reference to this Plant's JSON object",
+    )
+
+
+class Plant(PlantRef, WithAttachmentsMixin, WithAltIdsMixin):
+    """Represent a manufacturing plant."""
+
     pluscode: str | None = pyd.Field(
         default=None,
         description="(deprecated) Plus code (aka Open Location Code) of plant's location",
@@ -85,12 +101,6 @@ class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         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,
-        description="Manufacturer's name for plant. Recommended < 40 chars",
-        example="Dalton, GA",
-        default=None,
-    )
     address: str | None = pyd.Field(
         max_length=200,
         default=None,