ocelescope-module-filter 0.1.0__tar.gz

ocelescope_module_filter-0.1.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.3
+Name: ocelescope-module-filter
+Version: 0.1.0
+Summary: Ocelescope backend module providing basic filtering of OCELs
+Requires-Dist: fastapi
+Requires-Dist: ocelescope-backend
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# ocelescope-module-filter
+
+The backend module providing basic filtering functionality for object-centric
+event logs in Ocelescope.
+
+This package provides the FastAPI routes consumed by the
+[`@ocelescope/filter`](https://www.npmjs.com/package/@ocelescope/filter)
+frontend module.
+
+## Installation
+
+```bash
+pip install ocelescope-module-filter
+```
+
+The module registers itself with the host through the
+`ocelescope_backend.modules` entry point and is discovered automatically once
+[`ocelescope-backend`](../../ocelescope-backend) is running.
+
+## About
+
+Part of [Ocelescope](https://github.com/promi4s/ocelescope), a framework for
+working with Object-Centric Event Logs developed at the Chair of Process and
+Data Science (PADS), RWTH Aachen University.
+
+📖 Documentation: <https://www.ocelescope.org>

ocelescope_module_filter-0.1.0/README.md

@@ -0,0 +1,26 @@
+# ocelescope-module-filter
+
+The backend module providing basic filtering functionality for object-centric
+event logs in Ocelescope.
+
+This package provides the FastAPI routes consumed by the
+[`@ocelescope/filter`](https://www.npmjs.com/package/@ocelescope/filter)
+frontend module.
+
+## Installation
+
+```bash
+pip install ocelescope-module-filter
+```
+
+The module registers itself with the host through the
+`ocelescope_backend.modules` entry point and is discovered automatically once
+[`ocelescope-backend`](../../ocelescope-backend) is running.
+
+## About
+
+Part of [Ocelescope](https://github.com/promi4s/ocelescope), a framework for
+working with Object-Centric Event Logs developed at the Chair of Process and
+Data Science (PADS), RWTH Aachen University.
+
+📖 Documentation: <https://www.ocelescope.org>

ocelescope_module_filter-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "ocelescope-module-filter"
+version = "0.1.0"
+description = "Ocelescope backend module providing basic filtering of OCELs"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = ["fastapi", "ocelescope-backend"]
+
+[project.entry-points."ocelescope_backend.modules"]
+filterV1 = "ocelescope_module_filter.module:Filter"
+
+
+[build-system]
+requires = ["uv_build>=0.11.21,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv]
+package = true
+
+[tool.uv.sources]
+ocelescope-backend = { workspace = true }

ocelescope_module_filter-0.1.0/src/ocelescope_module_filter/models.py

@@ -0,0 +1,58 @@
+from typing import Annotated, Literal
+
+from ocelescope_backend.app.modules import ModuleFilter
+from pydantic import Field
+
+from ocelescope import (
+    E2OCountFilter,
+    EventAttributeFilter,
+    EventTypeFilter,
+    O2OCountFilter,
+    ObjectAttributeFilter,
+    ObjectTypeFilter,
+    TimeFrameFilter,
+)
+
+
+class NativeFilterBase(ModuleFilter):
+    OcelescopeModuleSource = "FilterV1"
+
+
+class NativeE2OCountFilter(NativeFilterBase, E2OCountFilter):
+    type: Literal["e2o_count"]
+
+
+class NativeO2OCountFilter(NativeFilterBase, O2OCountFilter):
+    type: Literal["o2o_count"]
+
+
+class NativeActivityFilter(NativeFilterBase, EventTypeFilter):
+    type: Literal["activity"]
+
+
+class NativeObjectTypeFilter(NativeFilterBase, ObjectTypeFilter):
+    type: Literal["object_type"]
+
+
+class NativeEventAttributeFilter(NativeFilterBase, EventAttributeFilter):
+    type: Literal["event_attribute"]
+
+
+class NativeObjectAttributeFilter(NativeFilterBase, ObjectAttributeFilter):
+    type: Literal["object_attribute"]
+
+
+class NativeTimeFrameFilter(NativeFilterBase, TimeFrameFilter):
+    type: Literal["time_frame"]
+
+
+NativeFilter = Annotated[
+    NativeActivityFilter
+    | NativeObjectTypeFilter
+    | NativeTimeFrameFilter
+    | NativeEventAttributeFilter
+    | NativeObjectAttributeFilter
+    | NativeE2OCountFilter
+    | NativeO2OCountFilter,
+    Field(discriminator="type"),
+]

ocelescope_module_filter-0.1.0/src/ocelescope_module_filter/module.py

@@ -0,0 +1,19 @@
+from fastapi import FastAPI
+from ocelescope_backend.app.modules import Module, ModuleMeta
+from packaging.version import Version
+
+from ocelescope_module_filter.routes import router
+
+
+class Filter(Module):
+    meta = ModuleMeta(key="filter", version=Version("1.0"))
+
+    @classmethod
+    def create_app(cls) -> FastAPI:
+        app = FastAPI(
+            title="Filter", version=str(cls.meta.version), docs_url=None, redoc_url=None
+        )
+
+        app.include_router(router)
+
+        return app

ocelescope_module_filter-0.1.0/src/ocelescope_module_filter/routes.py

@@ -0,0 +1,33 @@
+from typing import cast
+
+from fastapi import APIRouter
+from ocelescope_backend.app.dependencies import ApiSession
+
+from ocelescope_module_filter.models import (
+    NativeFilter,
+    NativeFilterBase,
+)
+
+router = APIRouter()
+
+
+@router.get("/{ocel_id}/filter", operation_id="getFilter")
+def getFilter(
+    ocel_id: str,
+    session: ApiSession,
+) -> list[NativeFilter]:
+
+    native_filter_list = cast(
+        list[NativeFilter],
+        session.get_filter(ocel_id, NativeFilterBase.OcelescopeModuleSource),
+    )
+
+    return native_filter_list
+
+
+@router.post("/{ocel_id}/filter", operation_id="setFilter")
+def setFilter(ocel_id: str, body: list[NativeFilter], session: ApiSession):
+    return cast(
+        list[NativeFilter],
+        session.set_filter(ocel_id, NativeFilterBase.OcelescopeModuleSource, body),
+    )