django-mobileadmin 0.5.2

Download & Installation

Get the source from the application site at:

http://code.google.com/p/django-mobileadmin/

To install the mobileadmin, follow these steps:

1. Follow the instructions in the INSTALL.txt file

2. Add 'mobileadmin' to the INSTALLED_APPS setting of your Django site. That might look like this:

   INSTALLED_APPS = (
      # ...
      'mobileadmin',
   )

3. Make sure you’ve installed the admin contrib app.

4. Add 'mobileadmin.context_processors.user_agent' to your TEMPLATE_CONTEXT_PROCESSORS setting. It should look like this:

   TEMPLATE_CONTEXT_PROCESSORS = (
      'django.core.context_processors.auth',
      'django.core.context_processors.debug',
      'django.core.context_processors.i18n',
      'django.core.context_processors.media',
      'django.core.context_processors.request',
      'mobileadmin.context_processors.user_agent',
   )

Usage

Since mobileadmin follows the ideas of Django’s admin interface you can easily reuse your existing admin setup:

You use the default or custom ModelAdmin classes for each model you wanted to be editable in the admin interface and hooked up Django’s default AdminSite instance with your URLconf.

If that’s the case you are able to re-use those ModelAdmin (sub-)classes by using mobileadmin’s separate admin site instance and its autoregister() function.

1. In your root URLconf – just below the line where Django’s admin.autodiscover() gets called – import mobileadmin and call the function mobileadmin.autoregister():

   # urls.py
   from django.conf.urls.defaults import *
   from django.contrib import admin
   
   admin.autodiscover()
   
   import mobileadmin
   mobileadmin.autoregister()
   
   urlpatterns = patterns('',
       ('^admin/(.*)', admin.site.root),
   )

   This registers your existing admin configuration with mobileadmin.

2. Extend the urlpatterns to hook the default MobileAdminSite instance` with your favorite URL, e.g. /ma/. Add:

   urlpatterns += patterns('',
       (r'^ma/(.*)', mobileadmin.sites.site.root),
   )

   mobileadmin is now replicating all of the regular admin features and uses templates adapted to the mobile device you are using.

3. Set the handler404 and handler500 variables in your URLConf to the views that are provided by mobileadmin:

   handler404 = 'mobileadmin.views.page_not_found'
   handler500 = 'mobileadmin.views.server_error'

   That is needed to load the 404.html and 500.html templates according to the user agent of the browser on your mobile device. It has an automatic fallback to Django’s default error handlers.

Extending mobileadmin

mobileadmin comes with a default set of templates and patterns to recognize different devices and platforms:

• Mobile Safari (iPhone/iPod touch)

But it’s made for being extended.

Since the template loading depends on the user agent of the requesting client, mobileadmin tells Django to look for three templates, when trying to render one of the default admin views:

1. mobileadmin/USER_AGENT_NAME/VIEW_TEMPLATE.html

2. mobileadmin/VIEW_TEMPLATE.html

3. admin/index.html

..where:

• USER_AGENT is the short name of the user agent

• VIEW_TEMPLATE is the name of the rendered template

If you would try to access the login view with the iPhone for example, the following three templates would be tried to load:

1. mobileadmin/mobile_safari/login.html

2. mobileadmin/login.html

3. admin/index.html

..where mobile_safari is the name of one of the default device patterns and login.html the name of the to needed template.

MOBILEADMIN_USER_AGENTS = {
    'my_user_agent': r'.*MyUserAgent.*',
}

from mobileadmin import sites

class MyMobileAdminSite(sites.MobileAdminSite):
    # define here whatever function you want
    pass

from django.contrib.admin import sites
from mobileadmin.decorators import mobile_templates

class MyAdminSite(sites.AdminSite):

    def index(self, request, extra_context=None):

        # self.index_template is already automatically set here
        # do something cool here

        return super(MyAdminSite, self).index(request, extra_context)
    index = mobile_templates(index)

MOBILEADMIN_TEMPLATE_MAPPING = {
    'index': ('index_template', 'index.html'),
}

from mobileadmin import options
from myproject.myapp.models import Author

class MobileAuthorAdmin(options.MobileModelAdmin):
    pass
mobileadmin.sites.site.register(Author, MobileAuthorAdmin)

# urls.py
from django.conf.urls.defaults import *
from django.contrib import admin
import mobileadmin

admin.autodiscover()

urlpatterns = patterns('',
    ('^admin/(.*)', admin.site.root),
    (r'^ma/(.*)', mobileadmin.sites.site.root),
)

Media path

Please feel free to use some nice little helpers to find the path to mobileadmin’s media directory. If you are using Django (or any other Python software) to serve static files (which you shouldn’t in production) just use for example:

from mobileadmin.conf import settings

mobileadmin_media_path = settings.MEDIA_PATH
mobileadmin_media_prefix = settings.MEDIA_PREFIX

You now have the full (platform-independent) path to the media directory of mobileadmin in the variable mobileadmin_media_path and the default URL prefix ('/mobileadmin_media/') for the mobileadmin media – CSS, Javascript and images – in mobileadmin_media_prefix. Just like the ADMIN_MEDIA_PREFIX but for the media directory of the mobileadmin app.

You can of course optionally override the default URL prefix by setting a MOBILEADMIN_MEDIA_PREFIX in the settings.py file of your Django site. Please use a trailing slash. This makes updating mobileadmin much easier for you, since you now don’t have to bother about different locations of the media directory.

from mobileadmin.conf import settings

urlpatterns += patterns('django.views.static',
    (settings.MEDIA_REGEX, 'serve', {'document_root': settings.MEDIA_PATH}),
)

Support

Please leave your questions and problems on the designated Google Code site.