apis-data-projection 0.1.0__tar.gz

apis_data_projection-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to PyPI
+
+on:
+  push
+
+jobs:
+  build:
+    name: Build distribution  
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python   distribution   to PyPI
+    if: startsWith(github.ref, 'refs/tags/')
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/apis-data-projection/
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution   to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

apis_data_projection-0.1.0/.gitignore

@@ -0,0 +1,79 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+*.pyo
+build/
+dist/
+wheels/
+*.egg-info
+*.egg
+.eggs/
+MANIFEST
+
+# Virtual environments
+.venv
+venv/
+env/
+ENV/
+.env
+
+# Environment variables
+.env.local
+.env.*.local
+
+# Distribution / packaging
+*.tar.gz
+*.whl
+
+# Testing
+.tox/
+.nox/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.pytest_cache/
+.hypothesis/
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+.pytype/
+.pyre/
+
+# Linting / formatting
+.ruff_cache/
+
+# Django
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+media/
+staticfiles/
+static/
+
+# Django migrations (optional — remove if you want to track migrations)
+# */migrations/*.py
+# !*/migrations/__init__.py
+
+# Celery
+celerybeat-schedule
+celerybeat.pid
+
+# IDE / editors
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Jupyter Notebooks
+.ipynb_checkpoints/
+*.ipynb
+
+# uv / pip
+pip-log.txt
+pip-delete-this-directory.txt
+.uv/

apis_data_projection-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

apis_data_projection-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Saranya Balasubramanian
+
+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.

apis_data_projection-0.1.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: apis-data-projection
+Version: 0.1.0
+Summary: Data projection layer for APIS
+Project-URL: Homepage, https://github.com/gythaogg/apis-data-projection
+License-Expression: MIT
+License-File: LICENSE
+Keywords: data projection
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.13
+Requires-Dist: apis-acdhch-default-settings>=2.20.0
+Requires-Dist: apis-core-rdf>=0.64.5
+Description-Content-Type: text/markdown
+
+# apis-data-projection
+
+## Aim
+This package creates projections of APIS data models in order to
+- support fast universal search over entities and relations
+- create relation aware representation of entities. For eg. if there is "AA lives in XX relationship" then the representation of AA will contain "lives in XX" and the representation of XX will contain "residence of AA"
+- to support faceting and filtering by datetime
+- to provide an efficient relation layer for graph representations 
+
+
+

apis_data_projection-0.1.0/README.md

@@ -0,0 +1,11 @@
+# apis-data-projection
+
+## Aim
+This package creates projections of APIS data models in order to
+- support fast universal search over entities and relations
+- create relation aware representation of entities. For eg. if there is "AA lives in XX relationship" then the representation of AA will contain "lives in XX" and the representation of XX will contain "residence of AA"
+- to support faceting and filtering by datetime
+- to provide an efficient relation layer for graph representations 
+
+
+

apis_data_projection-0.1.0/apis_data_projection/admin.py

@@ -0,0 +1,43 @@
+from apis_data_projection.models import RelationProjection, EntityProjection, EntityFacet
+from django.contrib import admin, messages
+from django.http import HttpResponseRedirect
+from django.urls import path
+from django.template.response import TemplateResponse
+
+from .models import EntityProjection
+from .projection_sync import ProjectionSyncService
+from apis_core.entities.abc import Entity
+from apis_core.relations.models import Relation
+
+@admin.register(RelationProjection)
+class RelationProjectionAdmin(admin.ModelAdmin):
+    list_display = tuple(field.name for field in RelationProjection._meta.fields)
+
+@admin.register(EntityFacet)
+class EntityFacetAdmin(admin.ModelAdmin):
+    list_display = tuple(field.name for field in EntityFacet._meta.fields)
+
+
+@admin.register(EntityProjection)
+class EntityProjectionAdmin(admin.ModelAdmin):
+    list_display = [field.name for field in EntityProjection._meta.fields]
+
+    def get_urls(self):
+        urls = super().get_urls()
+        custom_urls = [
+            path(
+                "rebuild-projections/",
+                self.admin_site.admin_view(self.rebuild_projections_view),
+                name="apis_data_projection_rebuild_projections",
+            ),
+        ]
+        return custom_urls + urls
+
+    def rebuild_projections_view(self, request):
+        service = ProjectionSyncService(
+            abstract_entity_model=Entity,
+            relation_model=Relation,
+        )
+        service.sync_all()
+        self.message_user(request, "Projection rebuild completed.", level=messages.SUCCESS)
+        return HttpResponseRedirect("../")

apis_data_projection-0.1.0/apis_data_projection/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class ApisDataProjectionConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "apis_data_projection"
+    verbose_name = "APIS Data Projection"

apis_data_projection-0.1.0/apis_data_projection/checks.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from django.core.checks import Error, Warning, register
+
+
+
+def _has_attr(model, attr_name: str) -> bool:
+    try:
+        model._meta.get_field(attr_name)
+        return True
+    except Exception:
+        return hasattr(model, attr_name)
+
+
+@register()
+def apis_data_projection_checks(app_configs, **kwargs):
+    errors = []
+
+    try:
+        from apis_core.entities.abc import Entity
+    except Exception as exc:
+        errors.append(
+            Error(
+                "apis_core.entities.abc.Entity could not be imported.",
+                hint="Install and configure apis_core before using apis_data_projection.",
+                id="apis_data_projection.E001",
+                obj=exc,
+            )
+        )
+        Entity = None
+
+    try:
+        from apis_core.relations import Relation
+    except Exception as exc:
+        errors.append(
+            Error(
+                "apis_core.relations.Relation could not be imported.",
+                hint="Install and configure apis_core before using apis_data_projection.",
+                id="apis_data_projection.E002",
+                obj=exc,
+            )
+        )
+        Relation = None
+
+    if Entity is None or Relation is None:
+        return errors
+

apis_data_projection-0.1.0/apis_data_projection/config.py

@@ -0,0 +1,4 @@
+DEFAULT_FACET_CONFIG: dict[str, set[str]] = {
+    "entity_excluded_fields": set(),
+    "relation_excluded_fields": set(),
+}

apis_data_projection-0.1.0/apis_data_projection/management/commands/rebuild_projections.py

@@ -0,0 +1,16 @@
+from django.core.management.base import BaseCommand
+
+from apis_data_projection.projection_sync import ProjectionSyncService
+from apis_core.entities.abc import Entity
+from apis_core.relations.models import Relation
+
+class Command(BaseCommand):
+    help = "Rebuild entity and relation projections."
+
+    def handle(self, *args, **options):
+        service = ProjectionSyncService(
+            abstract_entity_model=Entity,
+            relation_model=Relation,
+        )
+        service.sync_all()
+        self.stdout.write(self.style.SUCCESS("Projection rebuild completed."))

apis_data_projection-0.1.0/apis_data_projection/migrations/0001_initial.py

@@ -0,0 +1,311 @@
+# Generated by Django 6.0.6 on 2026-06-19 09:38
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="EntityProjection",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("source_object_id", models.PositiveIntegerField()),
+                (
+                    "entity_type",
+                    models.CharField(
+                        db_index=True,
+                        help_text="Entity class name, e.g. Person, Place, Group.",
+                        max_length=100,
+                    ),
+                ),
+                ("label", models.CharField(db_index=True, max_length=255)),
+                ("uri", models.CharField(blank=True, max_length=500)),
+                ("search_text", models.TextField(blank=True)),
+                ("start_date", models.DateField(blank=True, null=True)),
+                ("end_date", models.DateField(blank=True, null=True)),
+                (
+                    "properties_json",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        help_text="dict representation of the entity's properties.",
+                    ),
+                ),
+                (
+                    "relations_json",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        help_text="dict representation of the entity's relations.",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "source_content_type",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="apis_data_projection_entity_projections",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["label"],
+            },
+        ),
+        migrations.CreateModel(
+            name="EntityFacet",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "name",
+                    models.CharField(
+                        db_index=True,
+                        help_text="Facet key, e.g. profession, gender, works in, place of residence.",
+                        max_length=100,
+                    ),
+                ),
+                (
+                    "value",
+                    models.CharField(
+                        db_index=True,
+                        help_text="Facet display value, e.g. Wizard, male, Ankh Morpork.",
+                        max_length=255,
+                    ),
+                ),
+                (
+                    "source",
+                    models.CharField(
+                        blank=True,
+                        help_text="Optional origin, e.g. profession, gender, relation:works in.",
+                        max_length=255,
+                    ),
+                ),
+                (
+                    "kind",
+                    models.CharField(
+                        blank=True,
+                        help_text="Optional classifier, e.g. scalar, fk, m2m, relation-derived.",
+                        max_length=30,
+                    ),
+                ),
+                (
+                    "weight",
+                    models.DecimalField(
+                        blank=True, decimal_places=2, max_digits=6, null=True
+                    ),
+                ),
+                (
+                    "extra",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        help_text="Optional extra facet metadata",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "entity_projection_id",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="facets",
+                        to="apis_data_projection.entityprojection",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["name", "value"],
+            },
+        ),
+        migrations.CreateModel(
+            name="RelationProjection",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("source_relation_object_id", models.PositiveIntegerField()),
+                ("subj_object_id", models.PositiveIntegerField()),
+                ("obj_object_id", models.PositiveIntegerField()),
+                ("subj_label", models.CharField(blank=True, max_length=255)),
+                ("obj_label", models.CharField(blank=True, max_length=255)),
+                ("subj_entity_type", models.CharField(db_index=True, max_length=100)),
+                ("obj_entity_type", models.CharField(db_index=True, max_length=100)),
+                (
+                    "relation_type",
+                    models.CharField(
+                        db_index=True, help_text="Relation class name", max_length=100
+                    ),
+                ),
+                ("forward_label", models.CharField(db_index=True, max_length=255)),
+                (
+                    "reverse_label",
+                    models.CharField(blank=True, db_index=True, max_length=255),
+                ),
+                ("search_text", models.TextField(blank=True)),
+                ("start_date", models.DateField(blank=True, null=True)),
+                ("end_date", models.DateField(blank=True, null=True)),
+                (
+                    "properties_json",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        help_text="Optional extra relation metadata that is not a first-class column.",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "obj_content_type",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="apis_data_projection_relation_obj",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+                (
+                    "source_relation_content_type",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="apis_data_projection_relation_projections",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+                (
+                    "subj_content_type",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="apis_data_projection_relation_subj",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["relation_type", "subj_label", "obj_label"],
+            },
+        ),
+        migrations.AddIndex(
+            model_name="entityprojection",
+            index=models.Index(
+                fields=["source_content_type", "source_object_id"],
+                name="apis_data_p_source__ae8955_idx",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="entityprojection",
+            index=models.Index(
+                fields=["entity_type"], name="apis_data_p_entity__a87a6d_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="entityprojection",
+            index=models.Index(fields=["label"], name="apis_data_p_label_493c50_idx"),
+        ),
+        migrations.AddConstraint(
+            model_name="entityprojection",
+            constraint=models.UniqueConstraint(
+                fields=("source_content_type", "source_object_id"),
+                name="uniq_entity_projection_source",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="entityfacet",
+            index=models.Index(
+                fields=["entity_projection_id"], name="apis_data_p_entity__3eec92_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="entityfacet",
+            index=models.Index(
+                fields=["name", "value"], name="apis_data_p_name_a349f0_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="entityfacet",
+            index=models.Index(fields=["name"], name="apis_data_p_name_bd2449_idx"),
+        ),
+        migrations.AddConstraint(
+            model_name="entityfacet",
+            constraint=models.UniqueConstraint(
+                fields=("entity_projection_id", "name", "value"),
+                name="uniq_entity_facet_per_projection",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="relationprojection",
+            index=models.Index(
+                fields=["source_relation_content_type", "source_relation_object_id"],
+                name="apis_data_p_source__2a9bae_idx",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="relationprojection",
+            index=models.Index(
+                fields=["subj_content_type", "subj_object_id"],
+                name="apis_data_p_subj_co_0bd7df_idx",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="relationprojection",
+            index=models.Index(
+                fields=["obj_content_type", "obj_object_id"],
+                name="apis_data_p_obj_con_255e1e_idx",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="relationprojection",
+            index=models.Index(
+                fields=["relation_type"], name="apis_data_p_relatio_ede626_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="relationprojection",
+            index=models.Index(
+                fields=["forward_label"], name="apis_data_p_forward_384d6d_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="relationprojection",
+            index=models.Index(
+                fields=["reverse_label"], name="apis_data_p_reverse_5ef6f2_idx"
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="relationprojection",
+            constraint=models.UniqueConstraint(
+                fields=("source_relation_content_type", "source_relation_object_id"),
+                name="uniq_relation_projection_source",
+            ),
+        ),
+    ]