django-admin-anchors 2.0.1

Link related objects in Django admin using decorators

Django Admin Anchors

Turn Django admin list display items into clickable links to related objects using decorators.

Installation

pip install django-admin-anchors

Usage

Take a look at the tests/project directory to see a runnable example project.

Add links to the object list page

from django.contrib import admin
from admin_anchors import admin_anchor
from yourapp.models import Team


@admin.register(Team)
class TeamAdmin(admin.ModelAdmin):
    list_display = ["__str__", "captain_link", "captains_profile_link", "members_link"]

    @admin_anchor("captain")
    def captain_link(self, instance):
        return str(instance.captain)

    @admin_anchor("captain.profile")
    def captains_profile_link(self, instance):
        return "Captains profile"

    @admin_anchor("members")
    def members_link(self, instance):
        return f"{instance.members.count()} members"

Add links to the object edit page

from django.contrib import admin
from admin_anchors import admin_anchor
from yourapp.models import Player


@admin.register(Player)
class PlayerAdmin(admin.ModelAdmin):
    readonly_fields = ["profile_link"]

    @admin_anchor("profile")
    def profile_link(self, instance):
        return "Profile"

Contributing

Setup

1. Clone the repository and enter the cloned folder
2. (optional) Create and activate a dedicated Python virtual environment
3. Run pip install -e ".[dev]" to install the projects requirements
4. (optional) Run pre-commit install to install the pre-commit hook

Pre-commit hook

Our pre-commit hook formats and lints the code.

Formatting and linting

• Run black admin_anchors tests to format the code
• Run flake8 admin_anchors tests to lint the code

Testing

• Run py.test --cov admin_anchors tests to run the tests in the current Python env
• Run tox to run the tests in all supported Python and Django environments

Makefile

All commands listed above have shortcut make recipes. Take a look at the Makefile to learn more.