flask-admin-autolinks 0.1.0__tar.gz

flask_admin_autolinks-0.1.0/.gitignore

@@ -0,0 +1,176 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+uv.lock
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

flask_admin_autolinks-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+        args: [--maxkb=1000]
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+        args: [--unsafe]  # needed if you have custom yaml tags anywhere
+      - id: debug-statements
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-executables-have-shebangs
+      - id: detect-private-key       # catches accidentally committed keys — cheap insurance
+      - id: mixed-line-ending
+
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.22.0
+    hooks:
+      - id: pyupgrade
+        args: [--py314-plus]  # match your actual target version
+
+  - repo: https://github.com/pycqa/isort
+    rev: 10.0.0b1
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/psf/black
+    rev: 26.10.1
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.4.1
+    hooks:
+      - id: flake8
+        additional_dependencies: ["flake8-pyproject"]
+
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.9.4
+    hooks:
+      - id: bandit
+        args: [-c, pyproject.toml]
+        additional_dependencies: ["bandit[toml]"]
+
+  - repo: https://github.com/rtts/djhtml
+    rev: 3.0.11
+    hooks:
+      - id: djhtml    # formats Jinja2/Django templates — you're wrestling Jinja2 in fonotarot, this cleans that up automatically

flask_admin_autolinks-0.1.0/LICENSE

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

flask_admin_autolinks-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.5
+Name: flask-admin-autolinks
+Version: 0.1.0
+Summary: Implements autolinks for related models in ModelView from Flask-Admin
+Author-email: Mario Hernandez <mariofix@proton.me>
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: flask-admin>=2.2.1
+Description-Content-Type: text/markdown
+
+# flask-admin-autolinks
+
+Automatic hyperlinks for relationship columns in Flask-Admin's SQLAlchemy list views.
+
+By default, a relationship column renders as plain text (`str()` of the related object). With this mixin, each related object becomes a link to its own edit (or details) page in the admin.
+
+## Features
+
+- Opt-in per view. No effect unless `column_relationship_links` is set.
+- Resolves the target view from the registered views by model. No endpoint naming convention required.
+- Respects the target view's `can_edit`, `can_view_details` and `is_accessible()`. Falls back to plain text.
+- Eager-loads link targets through the view's `_auto_joins`, so the list page does not issue N+1 queries.
+- Explicit `column_formatters` entries always win.
+- Output is escaped.
+
+## Installation
+
+```bash
+uv add flask-admin-autolinks
+# or
+pip install flask-admin-autolinks
+```
+
+Requires Flask-Admin with SQLAlchemy support (`flask-admin[sqlalchemy]`). Supported versions are declared in `pyproject.toml`.
+
+## Usage
+
+Place `AutoLinksMixin` before `ModelView` in the bases:
+
+```python
+from flask_admin.contrib.sqla import ModelView
+from flask_admin_autolinks import AutoLinksMixin
+
+
+class OrderView(AutoLinksMixin, ModelView):
+    column_list = ("id", "customer", "items")
+    column_relationship_links = True
+```
+
+For project-wide use, define a shared base once:
+
+```python
+class BaseView(AutoLinksMixin, ModelView):
+    column_relationship_links = True
+```
+
+Only relationship columns listed in `column_list` are linked.
+
+## Configuration
+
+`column_relationship_links` accepts:
+
+| Value | Behavior |
+| --- | --- |
+| `False` (default) | Disabled. |
+| `True` | Link every relationship column in `column_list` to the registered view for the related model. |
+| `dict[str, str]` | Same as `True`, with per-column overrides mapping a relationship name to a view endpoint. |
+
+```python
+class OrderView(AutoLinksMixin, ModelView):
+    column_list = ("id", "customer", "items")
+    column_relationship_links = {"customer": "client"}  # "client" is the target view's endpoint
+```
+
+An empty dict is falsy and leaves the feature disabled.
+
+## Behavior
+
+For each related object, the link target is chosen in this order:
+
+1. Target view has `can_edit` and is accessible: link to `edit_view`.
+2. Otherwise, target view has `can_view_details` and is accessible: link to `details_view`.
+3. Otherwise: escaped plain text.
+
+If no view is registered for the related model (or the override endpoint is not found), the cell renders as plain text. The list page is never broken by a missing target.
+
+Collections render as comma-separated links. `None` renders as an empty cell.
+
+A column that already has an entry in `column_formatters` is left untouched and is not eager-loaded by this package.
+
+## To Do
+
+- SQLAlchemy backend only (`flask_admin.contrib.sqla`), add others.
+
+## License
+
+See `LICENSE` for MIT License.
+
+## IA
+
+Documentation done with Claude.

flask_admin_autolinks-0.1.0/README.md

@@ -0,0 +1,91 @@
+# flask-admin-autolinks
+
+Automatic hyperlinks for relationship columns in Flask-Admin's SQLAlchemy list views.
+
+By default, a relationship column renders as plain text (`str()` of the related object). With this mixin, each related object becomes a link to its own edit (or details) page in the admin.
+
+## Features
+
+- Opt-in per view. No effect unless `column_relationship_links` is set.
+- Resolves the target view from the registered views by model. No endpoint naming convention required.
+- Respects the target view's `can_edit`, `can_view_details` and `is_accessible()`. Falls back to plain text.
+- Eager-loads link targets through the view's `_auto_joins`, so the list page does not issue N+1 queries.
+- Explicit `column_formatters` entries always win.
+- Output is escaped.
+
+## Installation
+
+```bash
+uv add flask-admin-autolinks
+# or
+pip install flask-admin-autolinks
+```
+
+Requires Flask-Admin with SQLAlchemy support (`flask-admin[sqlalchemy]`). Supported versions are declared in `pyproject.toml`.
+
+## Usage
+
+Place `AutoLinksMixin` before `ModelView` in the bases:
+
+```python
+from flask_admin.contrib.sqla import ModelView
+from flask_admin_autolinks import AutoLinksMixin
+
+
+class OrderView(AutoLinksMixin, ModelView):
+    column_list = ("id", "customer", "items")
+    column_relationship_links = True
+```
+
+For project-wide use, define a shared base once:
+
+```python
+class BaseView(AutoLinksMixin, ModelView):
+    column_relationship_links = True
+```
+
+Only relationship columns listed in `column_list` are linked.
+
+## Configuration
+
+`column_relationship_links` accepts:
+
+| Value | Behavior |
+| --- | --- |
+| `False` (default) | Disabled. |
+| `True` | Link every relationship column in `column_list` to the registered view for the related model. |
+| `dict[str, str]` | Same as `True`, with per-column overrides mapping a relationship name to a view endpoint. |
+
+```python
+class OrderView(AutoLinksMixin, ModelView):
+    column_list = ("id", "customer", "items")
+    column_relationship_links = {"customer": "client"}  # "client" is the target view's endpoint
+```
+
+An empty dict is falsy and leaves the feature disabled.
+
+## Behavior
+
+For each related object, the link target is chosen in this order:
+
+1. Target view has `can_edit` and is accessible: link to `edit_view`.
+2. Otherwise, target view has `can_view_details` and is accessible: link to `details_view`.
+3. Otherwise: escaped plain text.
+
+If no view is registered for the related model (or the override endpoint is not found), the cell renders as plain text. The list page is never broken by a missing target.
+
+Collections render as comma-separated links. `None` renders as an empty cell.
+
+A column that already has an entry in `column_formatters` is left untouched and is not eager-loaded by this package.
+
+## To Do
+
+- SQLAlchemy backend only (`flask_admin.contrib.sqla`), add others.
+
+## License
+
+See `LICENSE` for MIT License.
+
+## IA
+
+Documentation done with Claude.

flask_admin_autolinks-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "flask-admin-autolinks"
+version = "0.1.0"
+description = "Implements autolinks for related models in ModelView from Flask-Admin"
+readme = "README.md"
+authors = [{ name = "Mario Hernandez", email = "mariofix@proton.me" }]
+requires-python = ">=3.11"
+dependencies = ["flask-admin>=2.2.1"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/flask_admin_autolinks"]
+
+
+[dependency-groups]
+dev = ["pre-commit>=4.7.0"]
+
+
+[tool.black]
+line-length = 119
+target-version = ["py313"]
+
+[tool.isort]
+profile = "black"
+line_length = 119
+known_first_party = ["src/flask_admin_autolinks"]
+
+[tool.flake8]
+max-line-length = 119
+extend-ignore = ["E203", "W503"]                   # black-compatible
+exclude = [".git", "__pycache__", "build", "dist"]
+
+[tool.bandit]
+exclude_dirs = ["tests", "alembic"]
+skips = ["B101"]

flask_admin_autolinks-0.1.0/src/flask_admin_autolinks/__init__.py

@@ -0,0 +1,3 @@
+from .mixin import AutoLinksMixin
+
+__all__ = ["AutoLinksMixin"]

flask_admin_autolinks-0.1.0/src/flask_admin_autolinks/mixin.py

@@ -0,0 +1,69 @@
+"""Hyperlink relationship columns in Flask-Admin SQLAlchemy list views."""
+
+import typing as t
+
+from flask import url_for
+from flask_admin.contrib.sqla.tools import is_relationship
+from markupsafe import Markup, escape
+
+
+class AutoLinksMixin:
+    """Put before ModelView in the bases. True = auto-detect; dict = per-column endpoint override."""
+
+    column_relationship_links: bool | dict[str, str] = False
+
+    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
+        super().__init__(*args, **kwargs)
+        self._autolinks = self._scaffold_autolinks()
+        if self._autolinks:  # eager-load link targets: no N+1 on the list page
+            self._auto_joins = list({*self._auto_joins, *self._autolinks.values()})
+
+    def _scaffold_autolinks(self) -> dict[str, t.Any]:
+        if not self.column_relationship_links:
+            return {}
+        found = {}
+        for name, _label in self._list_columns:
+            if name in self.column_formatters:  # explicit formatters always win
+                continue
+            attr = getattr(self.model, name, None)
+            if attr is not None and is_relationship(attr):
+                found[name] = attr
+        return found
+
+    def _target_view(self, name: str, related_cls: type) -> t.Any:
+        links = self.column_relationship_links
+        endpoint = links.get(name) if isinstance(links, dict) else None
+        for view in self.admin._views:
+            if endpoint is not None:
+                if view.endpoint == endpoint:
+                    return view
+            elif getattr(view, "model", None) is related_cls:
+                return view
+        return None
+
+    @staticmethod
+    def _href(view: t.Any, target: t.Any) -> str | None:
+        if view is None or not view.is_accessible():
+            return None
+        pk = view.get_pk_value(target)
+        if view.can_edit:
+            return url_for(f"{view.endpoint}.edit_view", id=pk)
+        if view.can_view_details:
+            return url_for(f"{view.endpoint}.details_view", id=pk)
+        return None
+
+    def get_list_value(self, context: t.Any, model: t.Any, name: str) -> t.Any:
+        attr = self._autolinks.get(name)
+        if attr is None:
+            return super().get_list_value(context, model, name)
+        value = getattr(model, name)
+        if value is None:
+            return ""
+        prop = attr.property
+        view = self._target_view(name, prop.mapper.class_)
+        out = []
+        for target in value if prop.uselist else [value]:
+            label = escape(str(target))
+            href = self._href(view, target)
+            out.append(Markup('<a href="{}">{}</a>').format(href, label) if href else label)
+        return Markup(", ").join(out)