Welcome to django-intranet’s documentation!¶
Abstract¶
django-intranet is the minimal codebase to create fast enterprise
management applications.
Based on Django-1.4 you start a project, add intranet and the
other module you want to use.
That’s it, you are ready to go with your intranet.
Table of contents¶
Setup a new project¶
Install django-intranet¶
Create a project folder and enter it. Type these command lines.
$ sudo pip install django-intranet south
$ django-admin.py startproject myintranet
Configure the database¶
Configure the database and add ‘intranet’ and ‘south’ to your INSTALLED_APPS in myintranet/myintranet/settings.py.
Go to myintranet/ and type:
$ python manage.py migrate
Now you can install one of the contrib module or your own.
Setup the URLs¶
# -*- coding: utf-8 -*-
from django.conf.urls import patterns, include, url
from django.core.urlresolvers import reverse_lazy
from django.conf import settings
from django.views.generic import RedirectView
from django.contrib import admin
from intranet.urls import urlpatterns as intranet_urlpatterns
admin.autodiscover()
# Default URLs patterns from intranet
urlpatterns = intranet_urlpatterns
# Add specific patterns
urlpatterns += patterns('',
url(r'^$', RedirectView.as_view(url=reverse_lazy('dashboard'))),
# Apps
url(r'^prospect/', include('prospect.urls')),
# Admin URLs
url(r'^admin/', include(admin.site.urls)),
url(r'^admin_tools/', include('admin_tools.urls')),
)
if settings.DEBUG:
from django.conf.urls.static import static
from django.contrib.staticfiles.urls import staticfiles_urlpatterns
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
urlpatterns += staticfiles_urlpatterns()
Create a new module¶
Here are the few steps to create a django-intranet module.
Models¶
First of all create your models:
from django.db import models
from django.utils.translation import ugettext_lazy as _
class Category(models.Model):
name = models.CharField(_('name'), max_length=50)
def __unicode__(self):
return u'%s' % self.name
class Meta:
verbose_name = _('category')
ordering = ('name', )
class Prospect(models.Model):
company_name = models.CharField(_('company name'), max_length=100)
category = models.ForeignKey(Category, related_name="prospects")
title = models.CharField(_('title'), max_length=5, blank=True)
first_name = models.CharField(_('first name'), max_length=50, blank=True)
last_name = models.CharField(_('last name'), max_length=50, blank=True)
e_mail = models.EmailField(_('e-mail'), blank=True)
phone_number = PhoneField(_('phone number'), blank=True)
def __unicode__(self):
return u'%s' % self.company_name
class Meta:
verbose_name = _('prospect')
ordering = ['company_name']
URLs¶
You can automatically generate URLs and views for displays and treatments of your database: display of the list of your database table, display of the details of an entry, creation, modification and removal of an entry. To use this feature, you have to add the new generated URLs to your URL patterns:
from intranet.utils import get_default_model_url
from my_app.models import Category, Prospect
urlpatterns = get_default_model_url(Category)
urlpatterns += get_default_model_url(Prospect)
There are also a number of parameters you can customize:
- form_class: a customized form view for your model
- url_name: a string to name the URLs of your model in your application. By default it is the name of your model in lower-case.
- prefix_pattern: a string or a regular expression to define a prefix before the URLs of your model. There is no prefix by default.
- prefix_name: a string that will be used as a prefix before the name of your URLs (url_name). There is no prefix by default.
- list_view, detail_view, creation_view, update_view, delete_view: customized views for respectively the display of the list of your database entries, the display of one entry, the creation, update and removal of an entry.
For example, you could define the following URL pattern:
# Import your own vues.
from views import ProspectListView, ProspectDetailView
urlpatterns = get_default_model_url(
Prospect,
url_name = 'pro',
prefix_pattern = '(?P<company_id>\d+)/',
prefix_name = 'pre-',
list_view = ProspectListView,
detail_view = ProspectDetailView,
The previous code is equivalent to:
from views import ProspectListView, ProspectDetailView
from django.conf.urls import patterns, url
urlpatterns = patterns(url(
r'^(?P<company_id>\d+)/prospect/$',
login_required(list_view.as_view(model=Prospect)),
name = 'pre-pro-list'
))
urlpatterns = patterns(url(
r'^(?P<company_id>\d+)/prospect/(?P<pk>\d+)/$',
login_required(detail_view.as_view(model=Prospect)),
name = 'pre-pro-detail'
))
urlpatterns = patterns(url(
r'^(?P<company_id>\d+)/prospect/add/$',
login_required(creation_view.as_view(model=Prospect)),
name = 'pre-pro-add'
))
urlpatterns = patterns(url(
r'^(?P<company_id>\d+)/prospect/(?P<pk>\d+)/edit/$',
login_required(update_view.as_view(model=Prospect)),
name = 'pre-pro-edit'
))
urlpatterns = patterns(url(
r'^(?P<company_id>\d+)/prospect/(?P<pk>\d+)/delete/$',
login_required(delete_view.as_view(model=Prospect)),
name = 'pre-pro-delete'
))
Views¶
You can inherit from django-intranet base_views to customize your change_list display:
from intranet.base_views import IntranetListView
class ProspectListView(IntranetListView):
list_display = ('company_name', 'last_name', 'category')
list_display_links = ('company_name',)
search_fields = (
'company_name',
'first_name',
'last_name',
'category__name',
)
Templates¶
You will probably have to customize the model_detail template:
You can create templates/<module_name>/<model>/model_detail.html
For our app, we will create : templates/prospect/prospect/model_detail.html and templates/prospect/category/model_detail.html
{% extends 'intranet/model_detail.html' %}
{% load i18n intranet_extra intranet_values_extras %}
{% load url from future %}
{% block title_content %}{{ verbose_name|capfirst }} : {{ object|upper }}{% endblock %}
{% block content %}
<div class="row-fluid">
<div class="span3">
<table class="{% default_table_class %}">
<tr><th colspan="2" style="text-align:center;">{% trans "General" %}</th></tr>
<tr><th>{% trans "Company name" %}</th><td>{{ object.company_name|upper }}</td></tr>
<tr><th>{% trans "Category" %}</th><td><a href="{% url 'category-detail' object.category.pk %}">{{ object.category.name|title }}</a></td></tr>
</table>
</div>
<div class="span3">
<table class="{% default_table_class %}">
<tr><th colspan="2" style="text-align:center;">{% trans "Contacts" %}</th></tr>
<tr><th>{% trans "Company head" %}</th><td>
{% if object.last_name == "" %}
{{object.first_name|title }}
{% else %}
{{ object.title|title }} {{object.first_name|title }} {{ object.last_name|upper }}
{% endif %}
</td></tr>
<tr><th>{% trans "Phone" %}</th><td>{{ object.phone_number|phone }}</td></tr>
<tr><th>{% trans "E-mail" %}</th><td><a href="mailto:{{ object.e_mail }}">{{ object.e_mail }}</a></td></tr>
</table>
</div>
</div>
{% endblock %}
Screenshots¶
Here are some screenshots of the templates of a project using django-intranet. We defined two models: Field and Prospect.
Display of the Field list:
Display of a customized view of a Field entry:
Display of the Prospect list:
Display of the details of a Prospect entry:
Creation of a prospect entry:
Modification of a prospect entry:
Utils¶
Widgets¶
django-intranet provides you with extra widgets for your form fields:
- The PhoneField, extended from Django’s CharField, enforces the entered data of the field to be in the form of a valid telephone number, and then django-intranet will refuse to save a wrong phone number in your database. The telephone number can have a prefix code, for example “+81.0123456789”. If it doesn’t have one, django-intranet will consider we are in France by default. It will then remove separating characters like ‘ ‘ or ‘.’, check the number of digits, and then save the number with the telephone code “+33.”.
- The SiretField, extended from Django’s CharField, enforces the entered data of the field to be in the form of a valid SIRET number. So django-intranet will check the number of digits and then use a simple algorithm to check if the entered number is a valid SIRET number.
Filters¶
You can also use the associated filters in your html templates:
- The filter “phone” transforms a number in the form “+81.0123456789” into “+810123456789” and a number in the form “+33.384289468” into “03 84 28 94 68” for better readablility.
- The filter “siret” transforms a number in the form “01234567890128” into “012 345 678 90128” for better readablility.