apis-datamodel 0.1.0__tar.gz

apis_datamodel-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/p/apis-datamodel/
+    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_datamodel-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

apis_datamodel-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: apis-datamodel
+Version: 0.1.0
+Summary: Datamodel showing entities and relationships
+Project-URL: Homepage, https://github.com/gythaogg/apis-datamodel
+Author: Saranya Balasubramanian
+License: MIT
+Keywords: datamodel,entities,relationships
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.13
+Requires-Dist: apis-core-rdf>=0.62.0
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# apis-datamodel
+
+A reusable Django app that introspects your [APIS Core](https://github.com/acdh-oeaw/apis-core-rdf) data model and displays a matrix of relations between entity types.
+
+## Features
+
+- Automatically discovers all `Relation` subclasses defined in your project
+- Renders a subject × object matrix where each cell shows the `name` and `reverse_name` of the relation
+- Overridable templates via Django's standard app template loading order
+- Django system checks to catch missing dependencies and misconfigured `INSTALLED_APPS` / URL includes early
+
+## Requirements
+
+- Python ≥ 3.13
+- Django (any version supported by `apis-core-rdf`)
+- `apis-core-rdf >= 0.62.0`
+
+## Installation
+
+```bash
+pip install apis-datamodel
+```
+
+## Setup
+
+### 1. Add to `INSTALLED_APPS`
+
+`apis_datamodel` must appear **after** your project app so project-level template overrides are discovered first:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "apis_core.apis_metainfo",
+    "apis_core.relations",
+    "apis_core.apis_entities",
+    "your_project",   # must come before apis_datamodel
+    "apis_datamodel",
+]
+```
+
+### 2. Include the URLs
+
+```python
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    ...
+    path("datamodel/", include("apis_datamodel.urls")),
+]
+```
+
+The matrix view is then available at `/datamodel/`.
+
+## Template customisation
+
+The package ships with two templates:
+
+| Template | Purpose |
+|---|---|
+| `apis_datamodel/base.html` | Wrapper — provides `dm_head` and `dm_content` blocks |
+| `apis_datamodel/datamodel.html` | Renders the relation matrix |
+
+To customise the layout, place a file at the same path inside your own app's `templates/` directory. Because your app is listed before `apis_datamodel` in `INSTALLED_APPS`, Django will pick yours up first.
+
+The package template for `datamodel.html` extends `apis_datamodel/base.html` by default, but you can point it at your own base template by passing a `parent_template` context variable:
+
+```python
+# e.g. in a subclassed view
+def get_context_data(self, **kwargs):
+    ctx = super().get_context_data(**kwargs)
+    ctx["parent_template"] = "base.html"
+    return ctx
+```
+
+## System checks
+
+The app registers three Django system checks that run with `manage.py check`:
+
+| ID | What it validates |
+|---|---|
+| `apis_datamodel.E001` | Required APIS Core apps are present in `INSTALLED_APPS` |
+| `apis_datamodel.E002` | `apis_datamodel.urls` is included in the root URLconf |
+| `apis_datamodel.E003` | `apis_datamodel` appears after the host project app in `INSTALLED_APPS` |
+
+## License
+
+MIT
+

apis_datamodel-0.1.0/README.md

@@ -0,0 +1,89 @@
+# apis-datamodel
+
+A reusable Django app that introspects your [APIS Core](https://github.com/acdh-oeaw/apis-core-rdf) data model and displays a matrix of relations between entity types.
+
+## Features
+
+- Automatically discovers all `Relation` subclasses defined in your project
+- Renders a subject × object matrix where each cell shows the `name` and `reverse_name` of the relation
+- Overridable templates via Django's standard app template loading order
+- Django system checks to catch missing dependencies and misconfigured `INSTALLED_APPS` / URL includes early
+
+## Requirements
+
+- Python ≥ 3.13
+- Django (any version supported by `apis-core-rdf`)
+- `apis-core-rdf >= 0.62.0`
+
+## Installation
+
+```bash
+pip install apis-datamodel
+```
+
+## Setup
+
+### 1. Add to `INSTALLED_APPS`
+
+`apis_datamodel` must appear **after** your project app so project-level template overrides are discovered first:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "apis_core.apis_metainfo",
+    "apis_core.relations",
+    "apis_core.apis_entities",
+    "your_project",   # must come before apis_datamodel
+    "apis_datamodel",
+]
+```
+
+### 2. Include the URLs
+
+```python
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    ...
+    path("datamodel/", include("apis_datamodel.urls")),
+]
+```
+
+The matrix view is then available at `/datamodel/`.
+
+## Template customisation
+
+The package ships with two templates:
+
+| Template | Purpose |
+|---|---|
+| `apis_datamodel/base.html` | Wrapper — provides `dm_head` and `dm_content` blocks |
+| `apis_datamodel/datamodel.html` | Renders the relation matrix |
+
+To customise the layout, place a file at the same path inside your own app's `templates/` directory. Because your app is listed before `apis_datamodel` in `INSTALLED_APPS`, Django will pick yours up first.
+
+The package template for `datamodel.html` extends `apis_datamodel/base.html` by default, but you can point it at your own base template by passing a `parent_template` context variable:
+
+```python
+# e.g. in a subclassed view
+def get_context_data(self, **kwargs):
+    ctx = super().get_context_data(**kwargs)
+    ctx["parent_template"] = "base.html"
+    return ctx
+```
+
+## System checks
+
+The app registers three Django system checks that run with `manage.py check`:
+
+| ID | What it validates |
+|---|---|
+| `apis_datamodel.E001` | Required APIS Core apps are present in `INSTALLED_APPS` |
+| `apis_datamodel.E002` | `apis_datamodel.urls` is included in the root URLconf |
+| `apis_datamodel.E003` | `apis_datamodel` appears after the host project app in `INSTALLED_APPS` |
+
+## License
+
+MIT
+

apis_datamodel-0.1.0/apis_datamodel/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+
+class ApisDatamodelConfig(AppConfig):
+    name = "apis_datamodel"
+
+    def ready(self) -> None:
+        # Import checks at startup so Django registers system checks.
+        from . import checks  # noqa: F401

apis_datamodel-0.1.0/apis_datamodel/checks.py

@@ -0,0 +1,94 @@
+from django.apps import apps
+from django.conf import settings
+from django.core.checks import Error, register
+from django.urls import URLResolver, get_resolver
+
+REQUIRED_APPS = (
+    "apis_core.apis_metainfo",
+    "apis_core.relations",
+    "apis_core.apis_entities",
+)
+REQUIRED_URLCONF = "apis_datamodel.urls"
+
+
+@register()
+def check_required_apis_core_apps(app_configs, **kwargs):
+    missing = [app_name for app_name in REQUIRED_APPS if not apps.is_installed(app_name)]
+    if not missing:
+        return []
+
+    return [
+        Error(
+            "Missing required APIS Core apps.",
+            hint=(
+                "Add the following apps to INSTALLED_APPS: "
+                + ", ".join(f'\"{app_name}\"' for app_name in missing)
+            ),
+            id="apis_datamodel.E001",
+        )
+    ]
+
+
+def _resolver_includes_urlconf(url_resolver: URLResolver, required_urlconf: str) -> bool:
+    current = getattr(url_resolver, "urlconf_name", None)
+    if isinstance(current, str) and current == required_urlconf:
+        return True
+
+    module_name = getattr(current, "__name__", None)
+    if module_name == required_urlconf:
+        return True
+
+    for pattern in getattr(url_resolver, "url_patterns", []):
+        if isinstance(pattern, URLResolver) and _resolver_includes_urlconf(pattern, required_urlconf):
+            return True
+    return False
+
+
+@register()
+def check_required_apis_datamodel_urls(app_configs, **kwargs):
+    if not apps.is_installed("apis_datamodel"):
+        return []
+
+    resolver = get_resolver(settings.ROOT_URLCONF)
+    if _resolver_includes_urlconf(resolver, REQUIRED_URLCONF):
+        return []
+
+    return [
+        Error(
+            "Missing required APIS datamodel URL include.",
+            hint=(
+                "Include the app urls in your root urlpatterns, for example: "
+                "path('datamodel/', include('apis_datamodel.urls'))"
+            ),
+            id="apis_datamodel.E002",
+        )
+    ]
+
+
+@register()
+def check_apis_datamodel_app_order(app_configs, **kwargs):
+    installed_apps = list(getattr(settings, "INSTALLED_APPS", []))
+    if "apis_datamodel" not in installed_apps:
+        return []
+
+    project_app = settings.ROOT_URLCONF.split(".", 1)[0]
+    if project_app not in installed_apps:
+        return []
+
+    apis_datamodel_index = installed_apps.index("apis_datamodel")
+    project_app_index = installed_apps.index(project_app)
+
+    if apis_datamodel_index > project_app_index:
+        return []
+
+    return [
+        Error(
+            "apis_datamodel must appear after the host project app in INSTALLED_APPS.",
+            hint=(
+                "Move 'apis_datamodel' below '"
+                f"{project_app}' in INSTALLED_APPS so project templates can override "
+                "apis_datamodel templates."
+            ),
+            id="apis_datamodel.E003",
+        )
+    ]

apis_datamodel-0.1.0/apis_datamodel/templates/apis_datamodel/base.html

@@ -0,0 +1,7 @@
+{% load static %}
+
+{% block dm_head %}
+{% endblock dm_head %}
+
+{% block dm_content %}
+{% endblock dm_content %}

apis_datamodel-0.1.0/apis_datamodel/templates/apis_datamodel/datamodel.html

@@ -0,0 +1,42 @@
+{% extends parent_template|default:"apis_datamodel/base.html" %}
+
+{% block title %}Relation Matrix{% endblock %}
+
+{% block dm_head %}
+
+{% endblock dm_head %}
+
+{% block dm_content %}
+<h1>Relation Matrix</h1>
+
+<figure>
+	<table>
+		<thead>
+			<tr>
+				<th scope="col">Subject \ Object</th>
+				{% for model_name in column_models %}
+				<th scope="col">{{ model_name }}</th>
+				{% endfor %}
+			</tr>
+		</thead>
+		<tbody>
+			{% for row in rows %}
+			<tr>
+				<th scope="row">{{ row.subj_model }}</th>
+				{% for cell in row.cells %}
+				<td>
+					{% if cell.labels %}
+						{% for label in cell.labels %}
+						<div>{{ label }}</div>
+						{% endfor %}
+					{% else %}
+						-
+					{% endif %}
+				</td>
+				{% endfor %}
+			</tr>
+			{% endfor %}
+		</tbody>
+	</table>
+</figure>
+{% endblock dm_content %}

apis_datamodel-0.1.0/apis_datamodel/urls.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from django.urls import include, path
+from . import views
+app_name = "apis_datamodel"
+urlpatterns = [
+    path("", views.DatamodelView.as_view(), name="datamodel"),
+]