industrial-model 0.1.25__tar.gz → 0.1.26__tar.gz

{industrial_model-0.1.25 → industrial_model-0.1.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: industrial-model
-Version: 0.1.25
+Version: 0.1.26
 Summary: Industrial Model ORM
 Author-email: Lucas Alves <lucasrosaalves@gmail.com>
 Classifier: Programming Language :: Python

{industrial_model-0.1.25 → industrial_model-0.1.26}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "industrial-model"
-version = "0.1.25"
+version = "0.1.26"
 description = "Industrial Model ORM"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -22,6 +22,10 @@ classifiers = [
 requires = ["hatchling >= 1.27"]
 build-backend = "hatchling.build"
 
+[tool.hatch.build]
+packages = ["industrial_model"]
+
+
 [tool.uv]
 dev-dependencies = [
     "dotenv>=0.9.9",

industrial_model-0.1.25/.python-version

@@ -1 +0,0 @@
-3.11

industrial_model-0.1.25/scripts/build.sh

@@ -1,4 +0,0 @@
-sh ./scripts/lint.sh
-rm -rf dist
-uv sync
-uv build

industrial_model-0.1.25/scripts/format.sh

@@ -1,2 +0,0 @@
-ruff check industrial_model tests --fix
-ruff format industrial_model tests

industrial_model-0.1.25/scripts/lint.sh

@@ -1,3 +0,0 @@
-mypy industrial_model tests
-ruff check industrial_model tests
-ruff format industrial_model tests --check

industrial_model-0.1.25/scripts/publish.sh

@@ -1,2 +0,0 @@
-sh ./scripts/build.sh
-uv publish

industrial_model-0.1.25/tests/cognite-sdk-config.yaml

@@ -1,15 +0,0 @@
-cognite:
-  project: "${CDF_PROJECT}"
-  client_name: "${CDF_CLIENT_NAME}"
-  base_url: "https://${CDF_CLUSTER}.cognitedata.com"
-  credentials:
-    client_credentials:
-      token_url: "${CDF_TOKEN_URL}"
-      client_id: "${CDF_CLIENT_ID}"
-      client_secret: "${CDF_CLIENT_SECRET}"
-      scopes: ["https://${CDF_CLUSTER}.cognitedata.com/.default"]
-
-data_model:
-  external_id: "${CDF_DATA_MODEL_EXTERNAL_ID}"
-  space: "${CDF_DATA_MODEL_SPACE}"
-  version: "${CDF_DATA_MODEL_VERSION}"

industrial_model-0.1.25/tests/hubs.py

@@ -1,37 +0,0 @@
-import os
-from pathlib import Path
-from string import Template
-from typing import Any
-
-import yaml
-from cognite.client import CogniteClient
-from dotenv import load_dotenv
-
-from industrial_model import DataModelId, Engine
-
-
-def generate_config(
-    config_file_path: str | None = None,
-) -> dict[str, dict[str, Any]]:
-    load_dotenv(override=True)
-    file_path = Path(
-        config_file_path or f"{os.path.dirname(__file__)}/cognite-sdk-config.yaml"
-    )
-    env_sub_template = Template(file_path.read_text())
-    file_env_parsed = env_sub_template.substitute(dict(os.environ))
-
-    value = yaml.safe_load(file_env_parsed)
-
-    assert isinstance(value, dict)
-    return value
-
-
-def generate_engine(config_file_path: str | None = None) -> Engine:
-    cognite_config = generate_config(config_file_path)
-    client = CogniteClient.load(cognite_config["cognite"])
-
-    client.config.timeout = 60
-    print(client.config)
-
-    dm_id = DataModelId.model_validate(cognite_config["data_model"])
-    return Engine(client, dm_id)

industrial_model-0.1.25/tests/models.py

@@ -1,92 +0,0 @@
-import datetime
-from typing import Annotated
-
-from pydantic import Field
-
-from industrial_model import (
-    InstanceId,
-    ViewInstance,
-    ViewInstanceConfig,
-    WritableViewInstance,
-)
-
-
-class DescribableEntity(ViewInstance):
-    name: str | None = None
-    description: str | None = None
-
-
-class ReportingSite(DescribableEntity):
-    time_zone: DescribableEntity | None = None
-
-
-class EventDetail(ViewInstance):
-    ref_metric_code: DescribableEntity | None = None
-    ref_event_code: DescribableEntity | None = None
-    ref_sub_category_l1: DescribableEntity | None = None
-    ref_sub_category_l2: DescribableEntity | None = None
-    ref_sub_category_l3: DescribableEntity | None = None
-    ref_sub_category_l4: DescribableEntity | None = None
-    ref_sub_category_l5: DescribableEntity | None = None
-    ref_equipment: DescribableEntity | None = None
-    ref_discipline: DescribableEntity | None = None
-
-
-class Event(ViewInstance):
-    view_config = ViewInstanceConfig(
-        view_external_id="OEEEvent",
-        instance_spaces_prefix="OEE-",
-    )
-    event_definition: str | None = None
-    start_date_time: datetime.datetime | None = None
-    ref_site: ReportingSite | None = None
-    ref_unit: DescribableEntity | None = None
-    ref_reporting_line: DescribableEntity | None = None
-    ref_reporting_location: DescribableEntity | None = None
-    ref_product: DescribableEntity | None = None
-    ref_material: DescribableEntity | None = None
-    ref_process_type: DescribableEntity | None = None
-    ref_oee_event_detail: Annotated[
-        list[EventDetail],
-        Field(default_factory=list, alias="refOEEEventDetail"),
-    ]
-
-
-class SearchEvent(ViewInstance):
-    view_config = ViewInstanceConfig(view_external_id="OEEEvent")
-
-    start_date_time: datetime.datetime
-    event_definition: str
-    ref_site: InstanceId
-
-
-class Msdp(ViewInstance):
-    view_config = ViewInstanceConfig(
-        view_external_id="OEEMSDP",
-        instance_spaces_prefix="OEE-",
-    )
-
-    effective_date: datetime.date
-
-
-class WritableEvent(WritableViewInstance):
-    view_config = ViewInstanceConfig(
-        view_external_id="OEEEvent",
-        instance_spaces_prefix="OEE-",
-    )
-
-    start_date_time: datetime.datetime | None = None
-    ref_site: ReportingSite | None = None
-    ref_reporting_line: DescribableEntity | None = None
-    ref_oee_event_detail: Annotated[
-        list[EventDetail],
-        Field(default_factory=list, alias="refOEEEventDetail"),
-    ]
-
-    def edge_id_factory(
-        self, target_node: InstanceId, edge_type: InstanceId
-    ) -> InstanceId:
-        return InstanceId(
-            external_id=f"{self.external_id}-{target_node.external_id}-{edge_type.external_id}",
-            space=self.space,
-        )

industrial_model-0.1.25/tests/test_schema.py

@@ -1,350 +0,0 @@
-from pydantic import BaseModel
-
-from industrial_model.models import get_schema_properties
-from tests.models import (
-    DescribableEntity,
-    Event,
-    EventDetail,
-    Msdp,
-    ReportingSite,
-    WritableEvent,
-)
-
-SEP = "|"
-
-
-class _Car(BaseModel):
-    model: str
-    year: int
-    owner: "SuperNestedModel"
-    previous_owners: list["SuperNestedModel"] | None
-
-
-class SuperNestedModel(DescribableEntity):
-    parent: "SuperNestedModel"
-    children: list["SuperNestedModel"]
-    cars: list[_Car] | None
-
-
-def test_get_schema_properties() -> None:
-    for entity, expected_schema in _get_test_schema().items():
-        schema = get_schema_properties(entity, SEP)
-        assert schema == expected_schema, f"Expected {expected_schema}, got {schema}"
-
-
-def _get_test_schema() -> dict[type[BaseModel], list[str]]:
-    return {
-        Msdp: ["effectiveDate", "externalId", "space"],
-        DescribableEntity: ["description", "externalId", "name", "space"],
-        ReportingSite: [
-            "description",
-            "externalId",
-            "name",
-            "space",
-            "timeZone",
-            "timeZone|description",
-            "timeZone|externalId",
-            "timeZone|name",
-            "timeZone|space",
-        ],
-        EventDetail: [
-            "externalId",
-            "refDiscipline",
-            "refDiscipline|description",
-            "refDiscipline|externalId",
-            "refDiscipline|name",
-            "refDiscipline|space",
-            "refEquipment",
-            "refEquipment|description",
-            "refEquipment|externalId",
-            "refEquipment|name",
-            "refEquipment|space",
-            "refEventCode",
-            "refEventCode|description",
-            "refEventCode|externalId",
-            "refEventCode|name",
-            "refEventCode|space",
-            "refMetricCode",
-            "refMetricCode|description",
-            "refMetricCode|externalId",
-            "refMetricCode|name",
-            "refMetricCode|space",
-            "refSubCategoryL1",
-            "refSubCategoryL1|description",
-            "refSubCategoryL1|externalId",
-            "refSubCategoryL1|name",
-            "refSubCategoryL1|space",
-            "refSubCategoryL2",
-            "refSubCategoryL2|description",
-            "refSubCategoryL2|externalId",
-            "refSubCategoryL2|name",
-            "refSubCategoryL2|space",
-            "refSubCategoryL3",
-            "refSubCategoryL3|description",
-            "refSubCategoryL3|externalId",
-            "refSubCategoryL3|name",
-            "refSubCategoryL3|space",
-            "refSubCategoryL4",
-            "refSubCategoryL4|description",
-            "refSubCategoryL4|externalId",
-            "refSubCategoryL4|name",
-            "refSubCategoryL4|space",
-            "refSubCategoryL5",
-            "refSubCategoryL5|description",
-            "refSubCategoryL5|externalId",
-            "refSubCategoryL5|name",
-            "refSubCategoryL5|space",
-            "space",
-        ],
-        Event: [
-            "externalId",
-            "refMaterial",
-            "refMaterial|description",
-            "refMaterial|externalId",
-            "refMaterial|name",
-            "refMaterial|space",
-            "refOEEEventDetail",
-            "refOEEEventDetail|externalId",
-            "refOEEEventDetail|refDiscipline",
-            "refOEEEventDetail|refDiscipline|description",
-            "refOEEEventDetail|refDiscipline|externalId",
-            "refOEEEventDetail|refDiscipline|name",
-            "refOEEEventDetail|refDiscipline|space",
-            "refOEEEventDetail|refEquipment",
-            "refOEEEventDetail|refEquipment|description",
-            "refOEEEventDetail|refEquipment|externalId",
-            "refOEEEventDetail|refEquipment|name",
-            "refOEEEventDetail|refEquipment|space",
-            "refOEEEventDetail|refEventCode",
-            "refOEEEventDetail|refEventCode|description",
-            "refOEEEventDetail|refEventCode|externalId",
-            "refOEEEventDetail|refEventCode|name",
-            "refOEEEventDetail|refEventCode|space",
-            "refOEEEventDetail|refMetricCode",
-            "refOEEEventDetail|refMetricCode|description",
-            "refOEEEventDetail|refMetricCode|externalId",
-            "refOEEEventDetail|refMetricCode|name",
-            "refOEEEventDetail|refMetricCode|space",
-            "refOEEEventDetail|refSubCategoryL1",
-            "refOEEEventDetail|refSubCategoryL1|description",
-            "refOEEEventDetail|refSubCategoryL1|externalId",
-            "refOEEEventDetail|refSubCategoryL1|name",
-            "refOEEEventDetail|refSubCategoryL1|space",
-            "refOEEEventDetail|refSubCategoryL2",
-            "refOEEEventDetail|refSubCategoryL2|description",
-            "refOEEEventDetail|refSubCategoryL2|externalId",
-            "refOEEEventDetail|refSubCategoryL2|name",
-            "refOEEEventDetail|refSubCategoryL2|space",
-            "refOEEEventDetail|refSubCategoryL3",
-            "refOEEEventDetail|refSubCategoryL3|description",
-            "refOEEEventDetail|refSubCategoryL3|externalId",
-            "refOEEEventDetail|refSubCategoryL3|name",
-            "refOEEEventDetail|refSubCategoryL3|space",
-            "refOEEEventDetail|refSubCategoryL4",
-            "refOEEEventDetail|refSubCategoryL4|description",
-            "refOEEEventDetail|refSubCategoryL4|externalId",
-            "refOEEEventDetail|refSubCategoryL4|name",
-            "refOEEEventDetail|refSubCategoryL4|space",
-            "refOEEEventDetail|refSubCategoryL5",
-            "refOEEEventDetail|refSubCategoryL5|description",
-            "refOEEEventDetail|refSubCategoryL5|externalId",
-            "refOEEEventDetail|refSubCategoryL5|name",
-            "refOEEEventDetail|refSubCategoryL5|space",
-            "refOEEEventDetail|space",
-            "refProcessType",
-            "refProcessType|description",
-            "refProcessType|externalId",
-            "refProcessType|name",
-            "refProcessType|space",
-            "refProduct",
-            "refProduct|description",
-            "refProduct|externalId",
-            "refProduct|name",
-            "refProduct|space",
-            "refReportingLine",
-            "refReportingLine|description",
-            "refReportingLine|externalId",
-            "refReportingLine|name",
-            "refReportingLine|space",
-            "refReportingLocation",
-            "refReportingLocation|description",
-            "refReportingLocation|externalId",
-            "refReportingLocation|name",
-            "refReportingLocation|space",
-            "refSite",
-            "refSite|description",
-            "refSite|externalId",
-            "refSite|name",
-            "refSite|space",
-            "refSite|timeZone",
-            "refSite|timeZone|description",
-            "refSite|timeZone|externalId",
-            "refSite|timeZone|name",
-            "refSite|timeZone|space",
-            "refUnit",
-            "refUnit|description",
-            "refUnit|externalId",
-            "refUnit|name",
-            "refUnit|space",
-            "space",
-            "startDateTime",
-        ],
-        WritableEvent: [
-            "externalId",
-            "refOEEEventDetail",
-            "refOEEEventDetail|externalId",
-            "refOEEEventDetail|refDiscipline",
-            "refOEEEventDetail|refDiscipline|description",
-            "refOEEEventDetail|refDiscipline|externalId",
-            "refOEEEventDetail|refDiscipline|name",
-            "refOEEEventDetail|refDiscipline|space",
-            "refOEEEventDetail|refEquipment",
-            "refOEEEventDetail|refEquipment|description",
-            "refOEEEventDetail|refEquipment|externalId",
-            "refOEEEventDetail|refEquipment|name",
-            "refOEEEventDetail|refEquipment|space",
-            "refOEEEventDetail|refEventCode",
-            "refOEEEventDetail|refEventCode|description",
-            "refOEEEventDetail|refEventCode|externalId",
-            "refOEEEventDetail|refEventCode|name",
-            "refOEEEventDetail|refEventCode|space",
-            "refOEEEventDetail|refMetricCode",
-            "refOEEEventDetail|refMetricCode|description",
-            "refOEEEventDetail|refMetricCode|externalId",
-            "refOEEEventDetail|refMetricCode|name",
-            "refOEEEventDetail|refMetricCode|space",
-            "refOEEEventDetail|refSubCategoryL1",
-            "refOEEEventDetail|refSubCategoryL1|description",
-            "refOEEEventDetail|refSubCategoryL1|externalId",
-            "refOEEEventDetail|refSubCategoryL1|name",
-            "refOEEEventDetail|refSubCategoryL1|space",
-            "refOEEEventDetail|refSubCategoryL2",
-            "refOEEEventDetail|refSubCategoryL2|description",
-            "refOEEEventDetail|refSubCategoryL2|externalId",
-            "refOEEEventDetail|refSubCategoryL2|name",
-            "refOEEEventDetail|refSubCategoryL2|space",
-            "refOEEEventDetail|refSubCategoryL3",
-            "refOEEEventDetail|refSubCategoryL3|description",
-            "refOEEEventDetail|refSubCategoryL3|externalId",
-            "refOEEEventDetail|refSubCategoryL3|name",
-            "refOEEEventDetail|refSubCategoryL3|space",
-            "refOEEEventDetail|refSubCategoryL4",
-            "refOEEEventDetail|refSubCategoryL4|description",
-            "refOEEEventDetail|refSubCategoryL4|externalId",
-            "refOEEEventDetail|refSubCategoryL4|name",
-            "refOEEEventDetail|refSubCategoryL4|space",
-            "refOEEEventDetail|refSubCategoryL5",
-            "refOEEEventDetail|refSubCategoryL5|description",
-            "refOEEEventDetail|refSubCategoryL5|externalId",
-            "refOEEEventDetail|refSubCategoryL5|name",
-            "refOEEEventDetail|refSubCategoryL5|space",
-            "refOEEEventDetail|space",
-            "refReportingLine",
-            "refReportingLine|description",
-            "refReportingLine|externalId",
-            "refReportingLine|name",
-            "refReportingLine|space",
-            "refSite",
-            "refSite|description",
-            "refSite|externalId",
-            "refSite|name",
-            "refSite|space",
-            "refSite|timeZone",
-            "refSite|timeZone|description",
-            "refSite|timeZone|externalId",
-            "refSite|timeZone|name",
-            "refSite|timeZone|space",
-            "space",
-            "startDateTime",
-        ],
-        SuperNestedModel: [
-            "cars",
-            "cars|model",
-            "cars|owner",
-            "cars|owner|cars",
-            "cars|owner|cars|model",
-            "cars|owner|cars|owner",
-            "cars|owner|cars|previous_owners",
-            "cars|owner|cars|year",
-            "cars|owner|children",
-            "cars|owner|description",
-            "cars|owner|externalId",
-            "cars|owner|name",
-            "cars|owner|parent",
-            "cars|owner|parent|cars",
-            "cars|owner|parent|cars|model",
-            "cars|owner|parent|cars|owner",
-            "cars|owner|parent|cars|previous_owners",
-            "cars|owner|parent|cars|year",
-            "cars|owner|parent|children",
-            "cars|owner|parent|description",
-            "cars|owner|parent|externalId",
-            "cars|owner|parent|name",
-            "cars|owner|parent|parent",
-            "cars|owner|parent|parent|cars",
-            "cars|owner|parent|parent|cars|model",
-            "cars|owner|parent|parent|cars|owner",
-            "cars|owner|parent|parent|cars|previous_owners",
-            "cars|owner|parent|parent|cars|year",
-            "cars|owner|parent|parent|children",
-            "cars|owner|parent|parent|description",
-            "cars|owner|parent|parent|externalId",
-            "cars|owner|parent|parent|name",
-            "cars|owner|parent|parent|parent",
-            "cars|owner|parent|parent|space",
-            "cars|owner|parent|space",
-            "cars|owner|space",
-            "cars|previous_owners",
-            "cars|year",
-            "children",
-            "children|cars",
-            "children|cars|model",
-            "children|cars|owner",
-            "children|cars|previous_owners",
-            "children|cars|year",
-            "children|children",
-            "children|description",
-            "children|externalId",
-            "children|name",
-            "children|parent",
-            "children|parent|cars",
-            "children|parent|cars|model",
-            "children|parent|cars|owner",
-            "children|parent|cars|previous_owners",
-            "children|parent|cars|year",
-            "children|parent|children",
-            "children|parent|description",
-            "children|parent|externalId",
-            "children|parent|name",
-            "children|parent|parent",
-            "children|parent|space",
-            "children|space",
-            "description",
-            "externalId",
-            "name",
-            "parent",
-            "parent|cars",
-            "parent|cars|model",
-            "parent|cars|owner",
-            "parent|cars|previous_owners",
-            "parent|cars|year",
-            "parent|children",
-            "parent|description",
-            "parent|externalId",
-            "parent|name",
-            "parent|parent",
-            "parent|parent|cars",
-            "parent|parent|cars|model",
-            "parent|parent|cars|owner",
-            "parent|parent|cars|previous_owners",
-            "parent|parent|cars|year",
-            "parent|parent|children",
-            "parent|parent|description",
-            "parent|parent|externalId",
-            "parent|parent|name",
-            "parent|parent|parent",
-            "parent|parent|space",
-            "parent|space",
-            "space",
-        ],
-    }

industrial_model-0.1.25/tests/tests_adapter.py

@@ -1,42 +0,0 @@
-import datetime
-import json
-
-from industrial_model import col, select
-
-from .hubs import generate_engine
-from .models import DescribableEntity, Event, Msdp
-
-if __name__ == "__main__":
-    adapter = generate_engine()
-
-    filter = (
-        col(Event.start_date_time).gt_(datetime.datetime(2025, 3, 1))
-        & col(Event.ref_site).nested_(DescribableEntity.external_id == "STS-CLK")
-        & (col(Event.start_date_time) < datetime.datetime(2025, 6, 1))
-    )
-
-    statement = select(Event).limit(100).where(filter).asc(Event.start_date_time)
-
-    result = [
-        item.model_dump(mode="json") for item in adapter.query_all_pages(statement)
-    ]
-    print(len(result))
-    json.dump(result, open("events.json", "w"), indent=2)
-
-    result_paginated = adapter.query(statement)
-    print(len(result_paginated.data))
-    json.dump(
-        result_paginated.model_dump(mode="json"),
-        open("events_paginated.json", "w"),
-        indent=2,
-    )
-
-    statement_msdp = (
-        select(Msdp).limit(2500).where(Msdp.effective_date >= datetime.date(2022, 5, 1))
-    )
-
-    result_msdp = [
-        item.model_dump(mode="json") for item in adapter.query_all_pages(statement_msdp)
-    ]
-    print(len(result_msdp))
-    json.dump(result_msdp, open("msdp.json", "w"), indent=2)

industrial_model-0.1.25/tests/tests_aggregate.py

@@ -1,19 +0,0 @@
-from industrial_model import (
-    AggregatedViewInstance,
-    ViewInstanceConfig,
-    aggregate,
-)
-
-from .hubs import generate_engine
-
-if __name__ == "__main__":
-    adapter = generate_engine()
-
-    default_config = ViewInstanceConfig(view_external_id="OEEEvent")
-
-    class AggregatedEvent(AggregatedViewInstance):
-        view_config = default_config
-        event_definition: str
-
-    aggregate_result = adapter.aggregate(aggregate(AggregatedEvent, "count"))
-    print(aggregate_result)

industrial_model-0.1.25/tests/tests_query.py

@@ -1,33 +0,0 @@
-import datetime
-import json
-from typing import Annotated
-
-from industrial_model.queries.models import BasePaginatedQuery
-from industrial_model.queries.params import QueryParam
-
-from .hubs import generate_engine
-from .models import Event
-
-if __name__ == "__main__":
-    adapter = generate_engine()
-
-    class EventRequest(BasePaginatedQuery):
-        start_date_time_gt: Annotated[
-            datetime.datetime | None,
-            QueryParam(property="startDateTime", operator=">"),
-        ] = None
-        event_definition_exists: Annotated[
-            bool | None, QueryParam(property="eventDefinition", operator="exists")
-        ] = None
-
-    filter = EventRequest(
-        start_date_time_gt=datetime.datetime(2025, 3, 1),
-        event_definition_exists=False,
-        limit=1,
-    )
-
-    statement = filter.to_statement(Event)
-
-    result = adapter.query(statement)
-    print(len(result.data))
-    json.dump(result.model_dump(mode="json"), open("events.json", "w"), indent=2)

industrial_model-0.1.25/tests/tests_search.py

@@ -1,28 +0,0 @@
-import datetime
-import json
-
-from industrial_model import col, search
-
-from .hubs import generate_engine
-from .models import Event, SearchEvent
-
-if __name__ == "__main__":
-    adapter = generate_engine()
-
-    filter = col(SearchEvent.start_date_time).gt_(datetime.datetime(2025, 3, 1)) & (
-        col(SearchEvent.start_date_time) < datetime.datetime(2025, 6, 1)
-    )
-
-    statement = (
-        search(SearchEvent)
-        .limit(-1)
-        .where(filter)
-        .desc(Event.start_date_time)
-        .query_by("not runn", [SearchEvent.event_definition])
-    )
-
-    items = adapter.search(statement)
-
-    result = [item.model_dump(mode="json") for item in items]
-    print(len(result))
-    json.dump(result, open("search.json", "w"), indent=2)