Django framework for mobilephone/smartphone site
Project description
django-mfw is a framework for developping mobile site with Django. The following feature is available
Detect accessing device via HTTP_USER_AGENT and determine the device can handle cookie or not.
Non cookie based Session and Csrf protection for the devices which cannot handle cookies.
Dynamically change loading template via the device information. That’s mean you can prepare the HTML template for each device (flavour template system)
Encode request and response via detected device encoding. It is required because some Japanese mobile phone cannot handle UTF-8
Translate Japanese Emoji in request and response to proper character code or image for PC.
Install
sudo pip install django-mfw
or:
sudo pip install git+git://github.com/lambdalisue/django-mfw.git#egg=django-mfw
Required (Automatically installed)
e4u (emoji4unicode bundle framework)
Quick tutorial
Add mfw and mfw.contrib.emoji to your INSTALL_APPS settings in settings.py
Add mfw.middleware.device.RequestDeviceDetectionMiddleware to the first item of MIDDLEWARE_CLASSES in settings.py and mfw.middleware.device.ResponseDeviceDetectionMiddleware to the last item of
Add mfw.middleware.session.SessionMiddleware and mfw.middleware.csrf.CsrfViewMiddleware to your MIDDLEWARE_CLASSES setting and comment out existing middlewares.
Add mfw.contrib.emoji.middleware.DeviceEmojiTranslationMiddleware and mfw.middleware.flavour.DeviceFlavourDetectionMiddleware to your MIDDLEWARE_CLASSES setting.
Add mfw.template.loaders.flavour.Loader to the first item of TEMPLATE_LOADERS setting.
Add mfw.context_processors.device and mfw.context_processors.flavour to your TEMPLATE_CONTEXT_PROCESSORS setting.
The code below describe sample settings. See settings.py for more detail.:
# List of callables that know how to import templates from various sources.
TEMPLATE_LOADERS = (
'mfw.template.loaders.flavour.Loader',
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
# 'django.template.loaders.eggs.Loader',
)
MIDDLEWARE_CLASSES = (
'mfw.middleware.device.RequestDeviceDetectionMiddleware',
'django.middleware.common.CommonMiddleware',
#'django.contrib.sessions.middleware.SessionMiddleware',
'mfw.middleware.session.SessionMiddleware',
#'django.middleware.csrf.CsrfViewMiddleware',
'mfw.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'mfw.contrib.emoji.middleware.DeviceEmojiTranslationMiddleware',
'mfw.middleware.flavour.DeviceFlavourDetectionMiddleware',
'mfw.middleware.device.ResponseDeviceDetectionMiddleware',
)
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",
"mfw.context_processors.device",
"mfw.context_processors.flavour",
)
Usage
Device detection
request device is detected with mfw.middleware.device.DeviceDetectionMiddleware and stored in request.device the device instance has following attributes
- device.support_cookie
is the device support cookie or not.
- device.kind
A kind of this device. It is used for flavour template system.
- device.name
A name of this device. It is used for flavour template system.
- device.model
A model name of this device. It is used for flavour template system.
- device.version
A version name of this device. It is used for flavour template system.
- device.encoding
A recommended encoding for the device. It is used to encode the request/response
- device.carrier (additional)
An attribute which Mobilephone device has. the carrier name of the device.
- device.uid (additional)
An attribute which Mobilephone device has. User id which is passed from carrier server.
- device.reliable (additional)
An attribute which Mobilephone device has. If False then the HTTP_USER_AGENT might be modified thus passed user id is not reliable enough.
Unicode emoji and Japanese carrier emoji conversion
mfw.contrib.emoji.middleware.DeviceEmojiTranslationMiddleware care it. it detect device and automatically translate unicode emoji to carrier’s encoded emoji in response. That’s why you do not need to care the code of emoji. Just write emoji as unicode emoji then middleware translate everything correctly and encode response to carrier’s encoding
Incoming translation is also handled the middleware. if request.GET or request.POST has carrier emoji, the middleware automatically translate the carrier emojis to unicode emojis and decode value to unicode.
Unicode emoji is found on http://www.unicode.org/~scherer/emoji4unicode/snapshot/full.html . this is a part of emoji4unicode project and translation method is using conversion table of it. see e4u for more detail.
Flavour template system
mfw.middleware.flavour.DeviceFlavourDetectionMiddleware detect device and automatically create flavour for device. the flavour is used for prefix of template_name. so if the flavour is smartphone/iphone/1.3 and called template name is blogs/post_detail.html then mfw.template.loaders.flavour.Loader will try to load the file listed below with template loaders listed in TEMPLATE_LOADERS except oneself.
TEMPLATE_DIRECTORY/smartphone/iphone/1.3/blogs/post_detail.html
TEMPLATE_DIRECTORY/smartphone/iphone/blogs/post_detail.html
TEMPLATE_DIRECTORY/smartphone/blogs/post_detail.html
TEMPLATE_DIRECTORY/blogs/post_detail.html
mfw.template.loaders.flavour.Loader is bundle loader and loading method is depended with template loaders listed in TEMPLATE_LOADERS so make sure you listed correct template loader in TEMPLATE_LOADERS
Special thanks
django-mfw’s concept is inspired by django-bpmobile django-mobile and emoji4unicode
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-mfw-0.4.1.tar.gz.
File metadata
- Download URL: django-mfw-0.4.1.tar.gz
- Upload date:
- Size: 219.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e725ae904dc2aa11f71c4fdd5022a8e03a8b2ed64f1a5847476451d95abc1824 |
|
| MD5 | f3ef931498dfea2057b7de57cf9f6c8c |
|
| BLAKE2b-256 | 04f7c785d883eb9db8f4c57bb5730d1ae95020a7f8f8ed41f338a97c81dd3a3e |
