Skip to main content

django-admin-fk-links

PyPI version

Reusable Django admin mixin that turns ForeignKey fields into direct clickable links to their related admin change views.


✨ Features

  • ✅ Converts ForeignKey fields into clickable links in list_display
  • ✅ Works with the default Django admin and custom AdminSite
  • ✅ Zero configuration
  • ✅ No need to add to INSTALLED_APPS
  • ✅ Fully compatible with Django 2.2+

📦 Installation

pip install django-admin-fk-links

🚀 Quick Usage

from django.contrib import admin
from django_admin_fk_links import ForeignKeyLinkMixin

@admin.register(Book)
class BookAdmin(ForeignKeyLinkMixin, admin.ModelAdmin):
    list_display = ("title", "author")
    list_display_foreign_key_links = ("author",)

That’s it. The author column will now be a direct link to its admin change view.


🖼️ Screenshots

Before — author rendered as plain text:

Book changelist without the mixin

After — author rendered as a clickable link to its change view:

Book changelist with the mixin


⚙️ How It Works

The mixin dynamically replaces the fields listed in:

list_display_foreign_key_links = ("field_name",)

with callables that render an <a> tag pointing to the related object’s admin change view.

It also supports:

  • Sorting via admin_order_field
  • Automatic verbose_name resolution
  • Custom AdminSite namespaces

✅ Compatibility

  • Django 2.2+
  • Python 3.7+
  • Default admin.site ✅
  • Custom AdminSite(name="custom") ✅

🪪 License

This project is licensed under the MIT License.


🤝 Contributing

Contributions, issues and feature requests are welcome. Feel free to open a PR or issue.

⭐ If you find it useful

Please consider giving the project a ⭐ on GitHub — it really helps!

Metadata

Release files for django-admin-fk-links 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-admin-fk-links 0.1.2
File Size Uploaded
django_admin_fk_links-0.1.2.tar.gz 5.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-admin-fk-links 0.1.2
File Interpreter ABI Platform
django_admin_fk_links-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 10.6 kB

Release history Release notifications | RSS feed

0.1.4

2 release files

0.1.3

2 release files

This release

0.1.2 This release

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page