ontobdc 0.1.0a0__tar.gz

ontobdc-0.1.0a0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ontobdc-0.1.0a0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: ontobdc
+Version: 0.1.0a0
+Summary: OntoBDC
+Author: Elias M P Junior
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich
+Requires-Dist: PyYAML
+Requires-Dist: numpy
+Dynamic: license-file
+
+# OntoBDC
+
+OntoBDC is a **domain and data layer** for engineering information.
+It provides:
+
+- Domain models (entities and schemas) for documents and datasets
+- File and dataset repositories built on top of folders and filesystems
+- Resource-oriented capabilities that can be composed into higher-level flows
+
+You can use OntoBDC as a Python package, via its own CLI
+(`ontobdc.sh` / `run/run.sh`), or integrated into other stacks.
+
+---
+
+## 🚀 Quick Start
+
+### 1. Install as a Python package
+
+From the root of this repository:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+
+pip install -e .
+```
+
+This makes the `ontobdc` package importable in your Python environment.
+
+### 2. Run capabilities via ontobdc CLI
+
+This repository provides a thin CLI wrapper in `ontobdc.sh` that dispatches
+to development tools and the capability runner:
+
+```bash
+./ontobdc.sh -h
+```
+
+Main commands:
+
+- `./ontobdc.sh run …`  → runs capabilities through `ontobdc/run/run.py`
+- `./ontobdc.sh plan …` → plans capability execution flows
+- `./ontobdc.sh commit` / `./ontobdc.sh branch` → Git workflow helpers for this repo
+
+You can also call the runner script directly:
+
+```bash
+./ontobdc/run/run.sh run --json
+```
+
+This prints a JSON catalog of registered capabilities, including those
+coming from OntoBDC itself and, if configured, other plugin packages.
+
+OntoBDC ships resource-oriented capabilities, for example
+to list documents from a repository:
+
+- `org.ontobdc.domain.resource.capability.list_documents_by_bbox`
+- `org.ontobdc.domain.resource.capability.list_documents_by_type`
+- `org.ontobdc.domain.resource.capability.list_documents_by_name_pattern`
+
+These capabilities are designed to work over a `FileRepositoryPort`
+implementation, typically backed by local folders or other storage
+adapters.
+
+## 🧩 Capabilities
+
+OntoBDC focuses on **resource and file-centric** capabilities. Examples:
+
+### Resource Capabilities
+
+These live under `ontobdc.resource.plugin.capability`:
+
+| ID | Description |
+|----|-------------|
+| `org.ontobdc.domain.resource.capability.list_documents_by_bbox` | Lists documents from a `FileRepositoryPort` filtered by bounding box and optional mimetypes. |
+| `org.ontobdc.domain.resource.capability.list_documents_by_type` | Lists documents filtered by logical type (e.g., models, drawings, reports). |
+| `org.ontobdc.domain.resource.capability.list_documents_by_name_pattern` | Lists documents filtered by name patterns (glob or regex-style matching). |
+
+These capabilities consume repositories defined in
+`ontobdc.resource.src.domain.port.repository` and adapters in
+`ontobdc.resource.src.adapter`.
+
+### Drive / PDF Capabilities
+
+Under `ontobdc.tmp.src.drive.plugin.capability.pdf` you will find
+experimental capabilities such as:
+
+- Attaching images to PDF files
+- Converting PDF pages to PNG
+- Extracting PDF pages to markdown
+- Counting pages in a PDF
+
+They are meant for document processing workflows that sit on top of
+OntoBDC’s file and dataset abstractions.
+
+---
+
+## 🏗️ Architecture
+
+OntoBDC is structured as a set of **layers**:
+
+- **Domain Ports and Entities**  
+  - `ontobdc.resource.src.domain.port.*` defines interfaces for entities
+    (documents, folders, datasets) and repositories.
+  - `ontobdc.resource.src.domain.entity` and schemas describe how these
+    resources are modeled.
+
+- **Adapters**  
+  - `ontobdc.resource.src.adapter` provides concrete adapters for
+    filesystem-based repositories and folder structures.
+  - `ontobdc.core.src.adapter` includes presentation adapters, such as
+    rich table rendering for terminal output.
+
+- **Capabilities**  
+  - `ontobdc.resource.plugin.capability` packages domain operations as
+    reusable capabilities compatible with the InfoBIM execution model.
+  - Drive / PDF capabilities live under `ontobdc.tmp.src.drive.plugin.capability`.
+
+- **Runner Integration**  
+  - `ontobdc/run/run.py` registers capabilities in a shared
+    `CapabilityRegistry` and wires them to the CLI, including
+    `--json` catalog export and an interactive menu when no capability ID
+    is provided.
+
+---
+
+## 🤖 For AI Agents
+
+OntoBDC is designed to be **agent-friendly**:
+
+- Capabilities expose structured input and output schemas
+- The runner supports a JSON catalog (`--json`) for automatic discovery
+- Planning helpers in `ontobdc/run/plan.py` can be used to build and
+  visualize multi-step execution graphs
+
+---
+
+## 🔗 Integration with other stacks (including InfoBIM IFC)
+
+OntoBDC can be embedded into larger stacks. One concrete example is the
+InfoBIM IFC stack, where:
+
+- OntoBDC provides the **domain model** and **resource capabilities**
+  (documents, repositories, datasets)
+- The stack adds IFC-centric capabilities (pipes, units, materials) and
+  a higher-level CLI
+
+In that scenario, capabilities from OntoBDC and from the host stack share
+the same capability registry and can be combined in planning/automation
+workflows.
+
+---
+
+## 📄 License
+
+OntoBDC is part of the **InfoBIM Community** ecosystem.  
+Licensed under **Apache 2.0**.***

ontobdc-0.1.0a0/README.md

@@ -0,0 +1,157 @@
+# OntoBDC
+
+OntoBDC is a **domain and data layer** for engineering information.
+It provides:
+
+- Domain models (entities and schemas) for documents and datasets
+- File and dataset repositories built on top of folders and filesystems
+- Resource-oriented capabilities that can be composed into higher-level flows
+
+You can use OntoBDC as a Python package, via its own CLI
+(`ontobdc.sh` / `run/run.sh`), or integrated into other stacks.
+
+---
+
+## 🚀 Quick Start
+
+### 1. Install as a Python package
+
+From the root of this repository:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+
+pip install -e .
+```
+
+This makes the `ontobdc` package importable in your Python environment.
+
+### 2. Run capabilities via ontobdc CLI
+
+This repository provides a thin CLI wrapper in `ontobdc.sh` that dispatches
+to development tools and the capability runner:
+
+```bash
+./ontobdc.sh -h
+```
+
+Main commands:
+
+- `./ontobdc.sh run …`  → runs capabilities through `ontobdc/run/run.py`
+- `./ontobdc.sh plan …` → plans capability execution flows
+- `./ontobdc.sh commit` / `./ontobdc.sh branch` → Git workflow helpers for this repo
+
+You can also call the runner script directly:
+
+```bash
+./ontobdc/run/run.sh run --json
+```
+
+This prints a JSON catalog of registered capabilities, including those
+coming from OntoBDC itself and, if configured, other plugin packages.
+
+OntoBDC ships resource-oriented capabilities, for example
+to list documents from a repository:
+
+- `org.ontobdc.domain.resource.capability.list_documents_by_bbox`
+- `org.ontobdc.domain.resource.capability.list_documents_by_type`
+- `org.ontobdc.domain.resource.capability.list_documents_by_name_pattern`
+
+These capabilities are designed to work over a `FileRepositoryPort`
+implementation, typically backed by local folders or other storage
+adapters.
+
+## 🧩 Capabilities
+
+OntoBDC focuses on **resource and file-centric** capabilities. Examples:
+
+### Resource Capabilities
+
+These live under `ontobdc.resource.plugin.capability`:
+
+| ID | Description |
+|----|-------------|
+| `org.ontobdc.domain.resource.capability.list_documents_by_bbox` | Lists documents from a `FileRepositoryPort` filtered by bounding box and optional mimetypes. |
+| `org.ontobdc.domain.resource.capability.list_documents_by_type` | Lists documents filtered by logical type (e.g., models, drawings, reports). |
+| `org.ontobdc.domain.resource.capability.list_documents_by_name_pattern` | Lists documents filtered by name patterns (glob or regex-style matching). |
+
+These capabilities consume repositories defined in
+`ontobdc.resource.src.domain.port.repository` and adapters in
+`ontobdc.resource.src.adapter`.
+
+### Drive / PDF Capabilities
+
+Under `ontobdc.tmp.src.drive.plugin.capability.pdf` you will find
+experimental capabilities such as:
+
+- Attaching images to PDF files
+- Converting PDF pages to PNG
+- Extracting PDF pages to markdown
+- Counting pages in a PDF
+
+They are meant for document processing workflows that sit on top of
+OntoBDC’s file and dataset abstractions.
+
+---
+
+## 🏗️ Architecture
+
+OntoBDC is structured as a set of **layers**:
+
+- **Domain Ports and Entities**  
+  - `ontobdc.resource.src.domain.port.*` defines interfaces for entities
+    (documents, folders, datasets) and repositories.
+  - `ontobdc.resource.src.domain.entity` and schemas describe how these
+    resources are modeled.
+
+- **Adapters**  
+  - `ontobdc.resource.src.adapter` provides concrete adapters for
+    filesystem-based repositories and folder structures.
+  - `ontobdc.core.src.adapter` includes presentation adapters, such as
+    rich table rendering for terminal output.
+
+- **Capabilities**  
+  - `ontobdc.resource.plugin.capability` packages domain operations as
+    reusable capabilities compatible with the InfoBIM execution model.
+  - Drive / PDF capabilities live under `ontobdc.tmp.src.drive.plugin.capability`.
+
+- **Runner Integration**  
+  - `ontobdc/run/run.py` registers capabilities in a shared
+    `CapabilityRegistry` and wires them to the CLI, including
+    `--json` catalog export and an interactive menu when no capability ID
+    is provided.
+
+---
+
+## 🤖 For AI Agents
+
+OntoBDC is designed to be **agent-friendly**:
+
+- Capabilities expose structured input and output schemas
+- The runner supports a JSON catalog (`--json`) for automatic discovery
+- Planning helpers in `ontobdc/run/plan.py` can be used to build and
+  visualize multi-step execution graphs
+
+---
+
+## 🔗 Integration with other stacks (including InfoBIM IFC)
+
+OntoBDC can be embedded into larger stacks. One concrete example is the
+InfoBIM IFC stack, where:
+
+- OntoBDC provides the **domain model** and **resource capabilities**
+  (documents, repositories, datasets)
+- The stack adds IFC-centric capabilities (pipes, units, materials) and
+  a higher-level CLI
+
+In that scenario, capabilities from OntoBDC and from the host stack share
+the same capability registry and can be combined in planning/automation
+workflows.
+
+---
+
+## 📄 License
+
+OntoBDC is part of the **InfoBIM Community** ecosystem.  
+Licensed under **Apache 2.0**.***

ontobdc-0.1.0a0/core/__init__.py

@@ -0,0 +1,2 @@
+__all__ = []
+

ontobdc-0.1.0a0/core/src/__init__.py

@@ -0,0 +1,2 @@
+__all__ = []
+

ontobdc-0.1.0a0/core/src/adapter/__init__.py

@@ -0,0 +1,4 @@
+from .rich_table import TableViewAdapter
+
+__all__ = ["TableViewAdapter"]
+

ontobdc-0.1.0a0/core/src/adapter/rich_table.py

@@ -0,0 +1,57 @@
+from typing import List, Tuple, Any
+
+from rich.box import Box
+from rich.table import Table
+
+
+DASHED_HORIZONTALS = Box(
+    " ── \n"
+    "    \n"
+    " ── \n"
+    "    \n"
+    " ╌╌ \n"
+    " ── \n"
+    "    \n"
+    " ── \n"
+)
+
+
+class TableViewAdapter:
+    PRIMARY_COLUMN = {"style": "cyan", "vertical": "top"}
+    NUMERIC_COLUMN = {"justify": "right", "vertical": "top"}
+    SECONDARY_COLUMN = {"style": "dim", "vertical": "top"}
+    INDEX_COLUMN = {"justify": "right", "style": "dim", "vertical": "top"}
+
+    @staticmethod
+    def create_table(
+        title: str,
+        columns: List[Tuple[str, Any]],
+        show_header: bool = True,
+        header_style: str = "bold white",
+        border_style: str = "grey35",
+    ) -> Table:
+        table = Table(
+            title=title,
+            box=DASHED_HORIZONTALS,
+            border_style=border_style,
+            show_lines=True,
+            show_header=show_header,
+            header_style=header_style,
+        )
+
+        for col_name, col_kwargs in columns:
+            table.add_column(col_name, **col_kwargs)
+
+        return table
+
+    @staticmethod
+    def col(label: str, kind: str = "primary", **overrides: Any) -> Tuple[str, Any]:
+        kind_map = {
+            "primary": TableViewAdapter.PRIMARY_COLUMN,
+            "numeric": TableViewAdapter.NUMERIC_COLUMN,
+            "secondary": TableViewAdapter.SECONDARY_COLUMN,
+            "index": TableViewAdapter.INDEX_COLUMN,
+        }
+        base = dict(kind_map.get(kind, {}))
+        base.update(overrides)
+        return label, base

ontobdc-0.1.0a0/core/src/domain/__init__.py

@@ -0,0 +1,2 @@
+__all__ = []
+

ontobdc-0.1.0a0/core/src/domain/port/__init__.py

@@ -0,0 +1,2 @@
+__all__ = []
+

ontobdc-0.1.0a0/core/src/domain/port/repository.py

@@ -0,0 +1,38 @@
+
+from abc import ABC, abstractmethod
+from typing import List, Dict, Any
+
+
+class RepositoryPort(ABC):
+    """
+    Base repository port.
+    """
+
+    @abstractmethod
+    def get_by_id(self, id: str) -> List[Any]:
+        """
+        Get a file resource by its ID.
+
+        :param id: The ID of the file resource.
+        :return: The file resource as a dictionary.
+        """
+        pass
+
+    @abstractmethod
+    def get_all(self) -> List[Any]:
+        """
+        Get all file resources.
+
+        :return: A list of file resources as dictionaries.
+        """
+        pass
+
+    @abstractmethod
+    def get_by_type(self, type: str) -> List[Any]:
+        """
+        Get all file resources of a certain type.
+
+        :param type: The type of the file resource.
+        :return: A list of file resources as dictionaries.
+        """
+        pass

ontobdc-0.1.0a0/core/src/domain/schema/__init__.py

@@ -0,0 +1,2 @@
+__all__ = []
+