README.rst

django-admin-footer

django-admin-footer provides a templatetag that renders a footer with version information in the Django admin.

Installation

Use pip to install the download and install the package from PyPi:

pip install django-admin-footer

Or checkout the source code from Github:

git clone https://github.com/collab-project/django-admin-footer.git
cd django-admin-footer
pip install -e .

Add admin_footer to INSTALLED_APPS in your Django project settings:

INSTALLED_APPS = (
    ...

    'admin_footer',
)

Usage

The ADMIN_FOOTER_DATA settings dict provides the data used in your footer. The default template expects the following template vars: site_url, site_name, period and version.

For example in settings.py:

from datetime import datetime
from myapp import version

ADMIN_FOOTER_DATA = {
  'site_url': 'https://www.google.com',
  'site_name': 'Google',
  'period': '{}'.format(datetime.now().year),
  'version': 'v{} - '.format(version)
}

Load the tag in your admin template (e.g. admin/base.html):

{% load footer %}

And add the admin_footer tag to the footer block:

{% block footer %}
{% admin_footer %}
{% endblock %}

You'll now see a copyright link at the bottom of the admin pages. The version information is hidden for non-staff users.