Admin

A blog web application

• We need to have an interface to

• post, delete and modify articles

• moderate comments

• manage authorized writers and viewers

➡ We need an administration interface

Why having an administration interface

• Inspecting data
see what the database contains

• Managing acquired data
insert, modify and delete database records

• Managing users
deﬁne who can access your application

✓ All of these should be accessible for non technical users

How to build such an administrator interface?

➡ We could build the administrator interface from scratch

๏ It's painfully, boring and repetitive to build it

✓ With Django “batteries are included”

Django provides

✓ An optional, pluggable and customizable admin interface ...

... and it looks really good!

Activate the admin interface
for your Django project

Step 1 - Modify the project settings
... setting.py
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
'WebDirectory',
# Uncomment the next line to enable the admin:
'django.contrib.admin',
# Uncomment the next line to enable admin documentation:
# 'django.contrib.admindocs',
)
...

Step 2 - Re-synchronize the database

$ python manage.py syncdb

Step 3 - Modify the project URL Dispatcher

urls.py
from django.conf.urls.defaults import patterns, include, url

urlpatterns = patterns('',
(r'^webdirectory/', include('WebDirectory.urls')))

from django.contrib import admin
admin.autodiscover()
urlpatterns += patterns('',(r'^admin/', include(admin.site.urls)))

The admin interface is ready!

URL of the admin site

The admin interface is ready!

URL of the admin site

So far, you can login as the
superuser created during
the ﬁrst database sync

Activate the admin interface
for the WebDirectory app

Step 1 - Create the admin.py ﬁle in WebDirectory

WebDirectory/
__init__.py
models.py
test.py
views.py
urls.py
admin.py
templates/
static/

Step 2 - Modify admin.py

WebDirectory/admin.py
from WebDirectory.models import Entry

admin.site.register(Entry)

Step 2 - Modify admin.py


admin.site.register(Entry)

makes the Entry data model available
on the admin interface

From WebDirectory admin you can


get the list of records


add records



add records


modify records


add records


modify records

delete records

Creating a dedicated administrator
for WebDirectory

The superuser administrator has all powers

• Create, modify and delete users

• Insert, modify, delete records from every application

How to be more restrictive?

✓ We want to create an administrator for the WebDirectory
application only

• A dedicated user admin named John Doe - login: jdoe

• With the administrative privileges to create, modify and
delete records in WebDirectory only

Create the John Doe admin user

login and password

user’s information

login and password


staff = admin power

login and password


staff = admin power

give all administrative
permissions for WebDirectory

What the administrator can do

After logging in as jdoe ...

What the administrator can do

After logging in as jdoe ...

... John Doe can administrate WebDirectory only

How to customize the admin interface?

✓ By editing the admin.py

• The class ModelAdmin is the representation of the models
in the admin interface

• Changing the admin options

1. create a new model admin object
class EntryAdmin(admin.ModelAdmin):
...

2. register this new admin object
admin.site.register()

Task 1 - Customizing the interface for editing a record

Default

Task 1 - Customizing the interface for editing a record

Default
Finally

ﬁelds grouped
in ﬁeldsets

Task 1.1 - Modify the ﬁeld order when editing a record

Default

Task 1.1 - Modify the ﬁeld order when editing a record

Default
After

ﬁelds reordered

Task 1.1 - Editing admin.py



Class EntryAdmin(admin.ModelAdmin):

fields = ['name', 'image', 'mimeType', 'webpage']

admin.site.register(Entry,EntryAdmin)

Task 1.2 - Splitting ﬁelds into ﬁeld sets

Now

Task 1.2 - Splitting fields into field sets

Now
Finally

fields grouped
in fieldsets



Class
fieldsets = [
('File info', {'fields': ['name','webpage']}),
('Upload image', {'fields': ['image','mimeType']})]

admin.site.register(Entry, MyAdmin)

Task 2 - Customizing the interface for listing all records

Default


Default
Finally

Multiple attributes displayed


Default
Finally
search by name



Default
Finally
search by name

Multiple attributes displayed ﬁlter by MIME type

Task 2.1 - Changing the record list output

Default

Task 2.1 - Changing the record list output

Default
After




Class
fieldsets = [

list_display = ('name', 'mimeType', 'webpage')


Task 2.2 - Adding ﬁlter and search

Now

Task 2.2 - Adding ﬁlter and search

Now

Finally
search by name

ﬁlter by MIME type

Adding ﬁlter and search

Class
fieldsets = [

list_display = ('name', 'mimeType', 'webpage')

list_filter = ['mimeType']

search_fields = ['name']


More customization

• We should be able to change the entire page layout

✓ Redefine HTML and CSS of the admin pages

➡ Redefine (extends) the predefined admin templates

Step 1 - Create an admin directory in the project

tsansweb/
__init__.py
manage.py
settings.py
urls.py
WebDirectory/
admin/
templates/
admin/

Step 2 - Copy the admin templates

• Find your Django installation path
$ python
>> import django my django_path
>> django.__file__
'/Library/Python/2.7/site-packages/django/__init__.pyc'

• Copy the templates index.html and base_site.html
from django_path/contrib/admin/templates/admin/
to project_path/tsansweb/admin/templates/

For example, change the title of the admin portal

admin/templates/admin/base_site.html
{% extends "admin/base.html" %}
{% load i18n %} title in the header

{% block title %}{{ title }}
| {% trans 'My Custom Admin Portal' %}{% endblock %}

{% block branding %}
<h1 id="site-name">{% trans 'My Custom Admin Portal' %}</h1>
{% endblock %}

{% block nav-global %}{% endblock %} title in the body

Admin

More Related Content

Similar to Admin (20)

Recently uploaded (20)

Admin

Editor's Notes