relrae 0.9.0__tar.gz

relrae-0.9.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 George Hannah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

relrae-0.9.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: relrae
+Version: 0.9.0
+Summary: Relationship Extraction, Labelling, Refinement, and Evaluation
+Author: George Hannah
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/KE-UniLiv/RELRaE_2
+Project-URL: Repository, https://github.com/KE-UniLiv/RELRaE_2.git
+Project-URL: Issues, https://github.com/KE-UniLiv/RELRaE_2/issues
+Keywords: knowledge-graphs,ontology,relationship-extraction,semantic-web,xml-schema
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: numpy
+Requires-Dist: pydantic
+Requires-Dist: PyYAML
+Requires-Dist: rdflib
+Requires-Dist: xmlschema
+Dynamic: license-file
+
+# RELRaE 2.0
+
+Relationship Extraction, Labelling, Refinement, and Evaluation (RELRaE) is a
+Python framework for generating and refining RDF ontologies from XML Schema
+definitions.
+
+## Requirements
+
+- Python 3.12 or newer
+
+## Installation
+
+Install the latest published release with pip:
+
+```console
+python -m pip install relrae
+```
+
+To install a local checkout for development:
+
+```console
+python -m pip install -e .
+```
+
+## Create a project
+
+Run the initializer inside a new project directory:
+
+```console
+relrae init
+```
+
+You can also provide the destination explicitly:
+
+```console
+relrae init path/to/project
+```
+
+This creates the following structure without overwriting existing files:
+
+```text
+relrae_components/
+├── config/
+│   ├── LLM_ref_conf.txt
+│   ├── RuBREx_conf.txt
+│   └── pipeline_conf.txt
+├── output/
+├── rules/
+│   └── SXPF_General_1_0.yaml
+└── schema/
+```
+
+Place an XML Schema file in `relrae_components/schema/`, then configure its
+filename, namespace, prefix, ontology name, and pipeline modules in
+`relrae_components/config/pipeline_conf.txt`.
+
+## Python API
+
+The main pipeline class is available from the package root:
+
+```python
+from relrae import RELRaE
+```
+
+See [`scripts/test_pipeline.py`](scripts/test_pipeline.py) for an end-to-end
+pipeline example using the sample data under `examples/`.
+
+## Building distributions
+
+Install the build frontend and create both source and wheel distributions:
+
+```console
+python -m pip install build
+python -m build
+```
+
+The publication artifacts are written to `dist/`. Check them before upload:
+
+```console
+python -m pip install twine
+python -m twine check dist/*
+```
+
+## Project links
+
+- [Source repository](https://github.com/KE-UniLiv/RELRaE_2)
+- [Issue tracker](https://github.com/KE-UniLiv/RELRaE_2/issues)
+
+## License
+
+RELRaE is distributed under the [MIT License](LICENSE).

relrae-0.9.0/README.md

@@ -0,0 +1,91 @@
+# RELRaE 2.0
+
+Relationship Extraction, Labelling, Refinement, and Evaluation (RELRaE) is a
+Python framework for generating and refining RDF ontologies from XML Schema
+definitions.
+
+## Requirements
+
+- Python 3.12 or newer
+
+## Installation
+
+Install the latest published release with pip:
+
+```console
+python -m pip install relrae
+```
+
+To install a local checkout for development:
+
+```console
+python -m pip install -e .
+```
+
+## Create a project
+
+Run the initializer inside a new project directory:
+
+```console
+relrae init
+```
+
+You can also provide the destination explicitly:
+
+```console
+relrae init path/to/project
+```
+
+This creates the following structure without overwriting existing files:
+
+```text
+relrae_components/
+├── config/
+│   ├── LLM_ref_conf.txt
+│   ├── RuBREx_conf.txt
+│   └── pipeline_conf.txt
+├── output/
+├── rules/
+│   └── SXPF_General_1_0.yaml
+└── schema/
+```
+
+Place an XML Schema file in `relrae_components/schema/`, then configure its
+filename, namespace, prefix, ontology name, and pipeline modules in
+`relrae_components/config/pipeline_conf.txt`.
+
+## Python API
+
+The main pipeline class is available from the package root:
+
+```python
+from relrae import RELRaE
+```
+
+See [`scripts/test_pipeline.py`](scripts/test_pipeline.py) for an end-to-end
+pipeline example using the sample data under `examples/`.
+
+## Building distributions
+
+Install the build frontend and create both source and wheel distributions:
+
+```console
+python -m pip install build
+python -m build
+```
+
+The publication artifacts are written to `dist/`. Check them before upload:
+
+```console
+python -m pip install twine
+python -m twine check dist/*
+```
+
+## Project links
+
+- [Source repository](https://github.com/KE-UniLiv/RELRaE_2)
+- [Issue tracker](https://github.com/KE-UniLiv/RELRaE_2/issues)
+
+## License
+
+RELRaE is distributed under the [MIT License](LICENSE).

relrae-0.9.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "relrae"
+dynamic = ["version"]
+description = "Relationship Extraction, Labelling, Refinement, and Evaluation"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+authors = [
+    { name = "George Hannah" },
+]
+keywords = [
+    "knowledge-graphs",
+    "ontology",
+    "relationship-extraction",
+    "semantic-web",
+    "xml-schema",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "lxml",
+    "numpy",
+    "pydantic",
+    "PyYAML",
+    "rdflib",
+    "xmlschema",
+]
+
+[project.urls]
+Homepage = "https://github.com/KE-UniLiv/RELRaE_2"
+Repository = "https://github.com/KE-UniLiv/RELRaE_2.git"
+Issues = "https://github.com/KE-UniLiv/RELRaE_2/issues"
+
+[project.scripts]
+relrae = "relrae.cli:main"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["relrae*"]
+
+[tool.setuptools.package-data]
+relrae = ["relrae_components/config/*.txt", "relrae_components/rules/*.yaml"]
+
+[tool.setuptools.dynamic]
+version = { attr = "relrae._version.__version__" }

relrae-0.9.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

relrae-0.9.0/src/relrae/RELRaE.py

@@ -0,0 +1,91 @@
+from rdflib import Graph, Namespace
+from rdflib.namespace import RDF, RDFS, OWL
+import xmlschema
+from pathlib import Path
+
+
+from .modules.RuBREx import RuBREx
+from .modules.LLM_Ref import LLMRefinement
+from .modules.human_fix import HumanFix
+from .utils import get_now
+
+
+class RELRaE:
+
+    def __init__(self, onto_name, schema, namespace, prefix, config,
+                 components_root="relrae_components", output_root="output"):
+        self.components_root = Path(components_root)
+        self.output_root = Path(output_root)
+        schema_path = self.components_root / "schema" / schema
+        self.schema = xmlschema.XMLSchema(schema_path)
+        self.namespace = Namespace(namespace)
+        self.prefix = prefix
+        self.onto_name = onto_name
+        self.onto = Graph()
+        self.errors = []
+        self.config = config
+        self.configs = [{"Pipeline": config}]
+        self.logs = {}
+
+        self.onto.bind('rdf', RDF)
+        self.onto.bind('rdfs', RDFS)
+        self.onto.bind('owl', OWL)
+        self.onto.bind(self.prefix, self.namespace)
+
+    def RuBREx(self):
+        m_rubrex = RuBREx(
+            self.schema, self.onto, self.prefix, self.namespace,
+            self.components_root,
+        )
+        m_rubrex.match_concepts()
+        m_rubrex.schema_coverage()
+
+        self.configs.append({"RuBREx": m_rubrex.config})
+        self.logs["RuBREx"] = m_rubrex.log
+        # NOTE: Consider the module complete
+        self.onto = self.onto + m_rubrex.onto
+        self.errors.append(m_rubrex.errors)
+
+    def LLM_Refinement_Loop(self):
+        m_LLM_ref = LLMRefinement(
+            self.schema, self.onto, self.prefix, self.namespace,
+            self.components_root)
+        m_LLM_ref.evaluate_relations()
+        self.errors.append(m_LLM_ref.errors)
+
+    def human_fix(self):
+        # TODO:
+        m_human_fix = HumanFix(
+            self.schema, self.onto, self.prefix, self.namespace,
+            self.components_root, self.errors, self.config["modules"]
+        )
+        m_human_fix.set_user_info()
+        m_human_fix.fix_errors()
+        m_human_fix.concepts_to_add_output(path)
+
+    def write_logs(self, path):
+        for key, values in self.logs.items():
+            with (path / f"{key}.txt").open("w", encoding="utf-8") as f:
+                for line in values:
+                    f.write(line + "\n")
+
+    def write_metadata(self, path):
+        with (path / "metadata.txt").open("w", encoding="utf-8") as f:
+            for config in self.configs:
+                for section, values in config.items():
+                    f.write(f"{section}\n\n")
+                    for key, value in values.items():
+                        f.write(f"{key}: {value}\n")
+                f.write("\n\n")
+
+    def serialise(self):
+        timestamp = get_now().replace(":", "-")
+        main_path = self.output_root / f"{self.onto_name}{timestamp}"
+        log_path = main_path / "logs"
+        log_path.mkdir(parents=True)
+        self.write_logs(log_path)
+        self.write_metadata(main_path)
+        self.onto.serialize(
+            destination=main_path / f"{self.onto_name}.ttl",
+            format="ttl",
+        )

relrae-0.9.0/src/relrae/__init__.py

@@ -0,0 +1,6 @@
+"""Public package interface for RELRaE."""
+
+from ._version import __version__
+from .RELRaE import RELRaE
+
+__all__ = ["RELRaE", "__version__"]

relrae-0.9.0/src/relrae/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    main()

relrae-0.9.0/src/relrae/_version.py

@@ -0,0 +1,3 @@
+"""The single source of truth for the RELRaE package version."""
+
+__version__ = "0.9.0"

relrae-0.9.0/src/relrae/cli.py

@@ -0,0 +1,65 @@
+import argparse
+from importlib.resources import files
+from pathlib import Path
+import shutil
+
+
+COMPONENT_DIRECTORIES = ("config", "rules", "schema", "output")
+
+
+def _copy_defaults(source, destination):
+    """Copy packaged defaults without replacing user-edited files."""
+    for resource in source.iterdir():
+        # Finder metadata is not part of a RELRaE project, even if it happens
+        # to be present in a source checkout.
+        if resource.name.startswith("."):
+            continue
+
+        target = destination / resource.name
+        if resource.is_dir():
+            target.mkdir(exist_ok=True)
+            _copy_defaults(resource, target)
+        elif not target.exists():
+            with resource.open("rb") as source_file, target.open("xb") as target_file:
+                shutil.copyfileobj(source_file, target_file)
+
+
+def initialise_project(project_root=None):
+    """Create a RELRaE project beneath *project_root* (the cwd by default).
+
+    Existing files are intentionally left untouched, making ``relrae init``
+    safe to run again after configuration files have been customised.
+    """
+    project_root = Path.cwd() if project_root is None else Path(project_root)
+    components_root = project_root / "relrae_components"
+
+    project_root.mkdir(parents=True, exist_ok=True)
+    for directory in COMPONENT_DIRECTORIES:
+        (components_root / directory).mkdir(parents=True, exist_ok=True)
+
+    packaged_defaults = files("relrae").joinpath("relrae_components")
+    _copy_defaults(packaged_defaults, components_root)
+
+    print(f"Initialised RELRaE project in {components_root}")
+    return components_root
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    subparsers = parser.add_subparsers(dest="command")
+
+    init_parser = subparsers.add_parser(
+        "init", help="create a RELRaE project in the current directory"
+    )
+    init_parser.add_argument(
+        "directory",
+        nargs="?",
+        default=Path.cwd(),
+        type=Path,
+        help="project directory (default: current directory)",
+    )
+
+    args = parser.parse_args()
+
+    if args.command == "init":
+        initialise_project(args.directory)