industrial-model 0.1.2__tar.gz → 0.1.4__tar.gz

industrial_model-0.1.4/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: industrial-model
+Version: 0.1.4
+Summary: Industrial Model ORM
+Author-email: Lucas Alves <lucasrosaalves@gmail.com>
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: anyio>=4.9.0
+Requires-Dist: cognite-sdk>=7.75.0
+Requires-Dist: pydantic>=2.11.4
+Description-Content-Type: text/markdown
+
+# 📦 industrial-model
+
+`industrial-model` is a Python ORM-style abstraction for querying views and data models in Cognite Data Fusion (CDF). It provides a declarative and type-safe way to model CDF views using `pydantic`, build queries, and interact with the CDF API in a Pythonic fashion.
+
+---
+
+## ✨ Features
+
+- Define CDF views using Pydantic-style classes.
+- Build complex queries using fluent and composable filters.
+- Easily fetch data using standard or paginated query execution.
+- Automatic alias and field transformation support.
+- Extensible and test-friendly design.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install industrial-model
+```
+
+---
+
+## 🛠️ Usage Example
+
+```python
+import datetime
+from cognite.client import CogniteClient
+from pydantic import Field
+
+from industrial_model import (
+    AsyncEngine,
+    DataModelId,
+    Engine,
+    ViewInstance,
+    select,
+    col,
+    and_,
+    or_,
+)
+
+# Define entities (view instances)
+
+
+class Car(ViewInstance):
+    name: str
+
+
+class Region(ViewInstance):
+    name: str
+
+
+class Country(ViewInstance):
+    name: str
+    region: Region = Field(
+        alias="regionRef"
+    )  # Maps property to field if names differ
+
+
+class Person(ViewInstance):
+    name: str
+    birthday: datetime.date
+    lives_in: Country
+    cars: list[Car]
+
+
+# By default, the ORM maps the class name to the view in the data model.
+# You can override this behavior using the `view_config` field.
+
+# For improved query performance, you can configure `instance_spaces` or `instance_spaces_prefix`
+# in the `view_config`. These options include space filters in the generated queries,
+# which can significantly reduce response times when working with large datasets.
+
+class AnotherPerson(ViewInstance):
+    view_config = ViewInstanceConfig(
+        view_external_id="Person",                    # Maps this class to the 'Person' view
+        instance_spaces_prefix="Industr-",            # Filters queries to spaces with this prefix
+        instance_spaces=["Industrial-Data"]           # Alternatively, explicitly filter by these spaces
+    )
+
+    name: str
+    birthday: datetime.date
+    lives_in: Country
+    cars: list[Car]
+
+
+# Initialize Cognite client and data model engine
+
+cognite_client = CogniteClient()
+
+data_model_id = DataModelId(
+    external_id="IndustrialData",
+    space="IndustralSpaceType",
+    version="v1"
+)
+
+engine = Engine(cognite_client, data_model_id)
+async_engine = AsyncEngine(cognite_client, data_model_id)  # Optional async engine
+
+
+# -----------------------------------
+# Example Queries
+# -----------------------------------
+
+# 1. Basic query: Find person named "Lucas"
+statement = select(Person).where(Person.name == "Lucas").limit(1)
+result = engine.query(statement)
+
+
+# 2. Combined filter with AND/OR
+statement = select(Person).where(
+    (Person.name == "Lucas") & (Person.birthday > datetime.date(2023, 1, 2)) |
+    (Person.name == "Another")
+)
+result = engine.query(statement)
+
+
+# 3. Same logic using `col()` expressions
+statement = select(Person).where(
+    (col("name").equals_("Lucas")) &
+    (col(Person.birthday).gt_("2023-01-02")) |
+    (Person.name == "Another")
+)
+result = engine.query(statement)
+
+
+# 4. Nested filtering using relationships
+statement = select(Person).where(
+    or_(
+        col(Person.lives_in).nested_(Country.name == "usa"),
+        and_(
+            col(Person.lives_in).nested_(col(Country.name).equals_("bra")),
+            col(Person.birthday).equals_("2023-01-01")
+        )
+    )
+)
+result = engine.query(statement)
+
+
+# 5. Paginated query with sorting and cursor
+statement = (
+    select(Person)
+    .where(
+        (Person.name == "Lucas") &
+        (Person.birthday > datetime.date(2023, 1, 2)) |
+        (Person.name == "Another")
+    )
+    .limit(10)
+    .cursor("NEXT CURSOR")
+    .asc(Person.name)
+)
+result = engine.query(statement)
+
+
+# 6. Fetch all pages of a query
+statement = select(Person).where(
+    (Person.name == "Lucas") &
+    (Person.birthday > datetime.date(2023, 1, 2)) |
+    (Person.name == "Another")
+)
+all_results = engine.query_all_pages(statement)
+
+```
+
+---

industrial_model-0.1.4/README.md

@@ -0,0 +1,166 @@
+# 📦 industrial-model
+
+`industrial-model` is a Python ORM-style abstraction for querying views and data models in Cognite Data Fusion (CDF). It provides a declarative and type-safe way to model CDF views using `pydantic`, build queries, and interact with the CDF API in a Pythonic fashion.
+
+---
+
+## ✨ Features
+
+- Define CDF views using Pydantic-style classes.
+- Build complex queries using fluent and composable filters.
+- Easily fetch data using standard or paginated query execution.
+- Automatic alias and field transformation support.
+- Extensible and test-friendly design.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install industrial-model
+```
+
+---
+
+## 🛠️ Usage Example
+
+```python
+import datetime
+from cognite.client import CogniteClient
+from pydantic import Field
+
+from industrial_model import (
+    AsyncEngine,
+    DataModelId,
+    Engine,
+    ViewInstance,
+    select,
+    col,
+    and_,
+    or_,
+)
+
+# Define entities (view instances)
+
+
+class Car(ViewInstance):
+    name: str
+
+
+class Region(ViewInstance):
+    name: str
+
+
+class Country(ViewInstance):
+    name: str
+    region: Region = Field(
+        alias="regionRef"
+    )  # Maps property to field if names differ
+
+
+class Person(ViewInstance):
+    name: str
+    birthday: datetime.date
+    lives_in: Country
+    cars: list[Car]
+
+
+# By default, the ORM maps the class name to the view in the data model.
+# You can override this behavior using the `view_config` field.
+
+# For improved query performance, you can configure `instance_spaces` or `instance_spaces_prefix`
+# in the `view_config`. These options include space filters in the generated queries,
+# which can significantly reduce response times when working with large datasets.
+
+class AnotherPerson(ViewInstance):
+    view_config = ViewInstanceConfig(
+        view_external_id="Person",                    # Maps this class to the 'Person' view
+        instance_spaces_prefix="Industr-",            # Filters queries to spaces with this prefix
+        instance_spaces=["Industrial-Data"]           # Alternatively, explicitly filter by these spaces
+    )
+
+    name: str
+    birthday: datetime.date
+    lives_in: Country
+    cars: list[Car]
+
+
+# Initialize Cognite client and data model engine
+
+cognite_client = CogniteClient()
+
+data_model_id = DataModelId(
+    external_id="IndustrialData",
+    space="IndustralSpaceType",
+    version="v1"
+)
+
+engine = Engine(cognite_client, data_model_id)
+async_engine = AsyncEngine(cognite_client, data_model_id)  # Optional async engine
+
+
+# -----------------------------------
+# Example Queries
+# -----------------------------------
+
+# 1. Basic query: Find person named "Lucas"
+statement = select(Person).where(Person.name == "Lucas").limit(1)
+result = engine.query(statement)
+
+
+# 2. Combined filter with AND/OR
+statement = select(Person).where(
+    (Person.name == "Lucas") & (Person.birthday > datetime.date(2023, 1, 2)) |
+    (Person.name == "Another")
+)
+result = engine.query(statement)
+
+
+# 3. Same logic using `col()` expressions
+statement = select(Person).where(
+    (col("name").equals_("Lucas")) &
+    (col(Person.birthday).gt_("2023-01-02")) |
+    (Person.name == "Another")
+)
+result = engine.query(statement)
+
+
+# 4. Nested filtering using relationships
+statement = select(Person).where(
+    or_(
+        col(Person.lives_in).nested_(Country.name == "usa"),
+        and_(
+            col(Person.lives_in).nested_(col(Country.name).equals_("bra")),
+            col(Person.birthday).equals_("2023-01-01")
+        )
+    )
+)
+result = engine.query(statement)
+
+
+# 5. Paginated query with sorting and cursor
+statement = (
+    select(Person)
+    .where(
+        (Person.name == "Lucas") &
+        (Person.birthday > datetime.date(2023, 1, 2)) |
+        (Person.name == "Another")
+    )
+    .limit(10)
+    .cursor("NEXT CURSOR")
+    .asc(Person.name)
+)
+result = engine.query(statement)
+
+
+# 6. Fetch all pages of a query
+statement = select(Person).where(
+    (Person.name == "Lucas") &
+    (Person.birthday > datetime.date(2023, 1, 2)) |
+    (Person.name == "Another")
+)
+all_results = engine.query_all_pages(statement)
+
+```
+
+---

{industrial_model-0.1.2 → industrial_model-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "industrial-model"
-version = "0.1.2"
+version = "0.1.4"
 description = "Industrial Model ORM"
 readme = "README.md"
 requires-python = ">=3.11"

industrial_model-0.1.2/PKG-INFO

@@ -1,23 +0,0 @@
-Metadata-Version: 2.4
-Name: industrial-model
-Version: 0.1.2
-Summary: Industrial Model ORM
-Author-email: Lucas Alves <lucasrosaalves@gmail.com>
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Database
-Classifier: Topic :: Database :: Database Engines/Servers
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-Requires-Dist: anyio>=4.9.0
-Requires-Dist: cognite-sdk>=7.75.0
-Requires-Dist: pydantic>=2.11.4
-Description-Content-Type: text/markdown
-
-# capybara
-
-![My Image](./assets/logo.jpeg)

industrial_model-0.1.2/README.md

@@ -1,3 +0,0 @@
-# capybara
-
-![My Image](./assets/logo.jpeg)