Setup a new project¶
Install django-prospect¶
Create a project folder and enter it. Now you must install django-intranet dependencies and create a new project:
$ virtualenv apps
$ source apps/bin/activate
(apps)$ pip install Django PIL MySQL-python South
(apps)$ pip install django-prospect
(apps)$ django-admin.py startproject myintranet
(apps)$ cd myintranet
Now it’s time to setup your database and to configure the settings module accordingly.
Configuration of the settings module¶
Here is a possible configuration of the file settings.py. Note that the variables ABSOLUTE_PATH, AUTHENTICATION_BACKENDS, ANONYMOUS_USER_ID, LOGIN_URL, LOGOUT_URL, LOGIN_REDIRECT_URL, PASSWORD_CHANGE_REDIRECT_URL, INTRANET_TITLE, AUTH_PROFILE_MODULE, PASSWORD_CHANGE_REDIRECT_URL are specific to django-intranet and must be specified. (Don’t forget the module imports at the beginning of the file.) Also check in the INSTALLED_APPS variable that you have not only django.contrib apps but also all the other apps like in the following example:
# -*- coding: utf-8 -*-
# Django settings for django-prospect project.
import os
from django.core.urlresolvers import reverse_lazy
ABSOLUTE_PATH = os.path.dirname(__file__)
DEBUG = True
TEMPLATE_DEBUG = DEBUG
ADMINS = (
('admin', 'admin@ionyse.com'),
)
MANAGERS = ADMINS
INTERNAL_IPS = ('127.0.0.1', )
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
'NAME': 'django_prospect_bdd', # Or path to database file if using sqlite3.
'USER': 'admin', # Not used with sqlite3.
'PASSWORD': 'the_password', # Not used with sqlite3.
'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
'PORT': '', # Set to empty string for default. Not used with sqlite3.
}
}
# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# On Unix systems, a value of None will cause Django to use the same
# timezone as the operating system.
# If running in a Windows environment this must be set to the same as your
# system time zone.
TIME_ZONE = 'Europe/Paris'
# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = 'fr-fr'
SITE_ID = 1
SITE_NAME = "Django Prospect"
GRAPPELLI_ADMIN_TITLE = SITE_NAME
# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True
# If you set this to False, Django will not format dates, numbers and
# calendars according to the current locale.
USE_L10N = True
# If you set this to False, Django will not use timezone-aware datetimes.
USE_TZ = True
# Absolute filesystem path to the directory that will hold user-uploaded files.
# Example: "/home/media/media.lawrence.com/media/"
MEDIA_ROOT = os.path.join(ABSOLUTE_PATH, 'medias')
# URL that handles the media served from MEDIA_ROOT. Make sure to use a
# trailing slash.
# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
MEDIA_URL = '/_medias/'
# Absolute path to the directory static files should be collected to.
# Don't put anything in this directory yourself; store your static files
# in apps' "static/" subdirectories and in STATICFILES_DIRS.
# Example: "/home/media/media.lawrence.com/static/"
STATIC_ROOT = os.path.join(ABSOLUTE_PATH, 'collected_static')
# URL prefix for static files.
# Example: "http://media.lawrence.com/static/"
STATIC_URL = '/_static/'
# Additional locations of static files
STATICFILES_DIRS = (
# Put strings here, like "/home/html/static" or "C:/www/django/static".
# Always use forward slashes, even on Windows.
# Don't forget to use absolute paths, not relative paths.
# os.path.join(ABSOLUTE_PATH, 'static'),
)
# List of finder classes that know how to find static files in
# various locations.
STATICFILES_FINDERS = (
'django.contrib.staticfiles.finders.FileSystemFinder',
'django.contrib.staticfiles.finders.AppDirectoriesFinder',
# 'django.contrib.staticfiles.finders.DefaultStorageFinder',
)
# Make this unique, and don't share it with anybody.
SECRET_KEY = '_$6a=hh50yz!o@(oks0+#6hx+8tmm3^ga#5_9%)xw0hrda%l^b'
# List of callables that know how to import templates from various sources.
TEMPLATE_LOADERS = (
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
# 'django.template.loaders.eggs.Loader',
)
TEMPLATE_CONTEXT_PROCESSORS = (
'django.contrib.auth.context_processors.auth',
'django.core.context_processors.debug',
'django.core.context_processors.i18n',
'django.core.context_processors.media',
'django.core.context_processors.static',
'django.core.context_processors.tz',
'django.contrib.messages.context_processors.messages',
'django.core.context_processors.request',
)
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
# Uncomment the next line for simple clickjacking protection:
# 'django.middleware.clickjacking.XFrameOptionsMiddleware',
)
ROOT_URLCONF = 'myintranet.urls'
# Python dotted path to the WSGI application used by Django's runserver.
WSGI_APPLICATION = 'myintranet.wsgi.application'
TEMPLATE_DIRS = (
# Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
# Always use forward slashes, even on Windows.
# Don't forget to use absolute paths, not relative paths.
os.path.join(ABSOLUTE_PATH, 'templates'),
)
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
'django.contrib.admin',
'django.contrib.admindocs',
'admin_tools',
'admin_tools.dashboard',
'intranet',
'floppyforms',
'bootstrap',
'south',
'guardian',
'prospect',
'xlrd',
)
# A sample logging configuration. The only tangible logging
# performed by this configuration is to send an email to
# the site admins on every HTTP 500 error when DEBUG=False.
# See http://docs.djangoproject.com/en/dev/topics/logging for
# more details on how to customize your logging configuration.
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'filters': {
'require_debug_false': {
'()': 'django.utils.log.RequireDebugFalse'
}
},
'handlers': {
'mail_admins': {
'level': 'ERROR',
'filters': ['require_debug_false'],
'class': 'django.utils.log.AdminEmailHandler'
}
},
'loggers': {
'django.request': {
'handlers': ['mail_admins'],
'level': 'ERROR',
'propagate': True,
},
}
}
AUTHENTICATION_BACKENDS = (
'intranet.backends.ObjectPermissionBackend',
'django.contrib.auth.backends.ModelBackend',
'guardian.backends.ObjectPermissionBackend',
)
# Configuration of Django Guardian
ANONYMOUS_USER_ID = -1
LOGIN_URL = reverse_lazy('login')
LOGOUT_URL = reverse_lazy('logout')
LOGIN_REDIRECT_URL = reverse_lazy('dashboard')
PASSWORD_CHANGE_REDIRECT_URL = reverse_lazy('profile')
INTRANET_TITLE = "Intranet"
AUTH_PROFILE_MODULE = 'intranet.UserProfile'
PASSWORD_CHANGE_REDIRECT_URL = reverse_lazy('profile')
When the database and the settings are configured, type these commands:
(apps)$ python manage.py syncdb --noinput --migrate
(apps)$ python manage.py createsuperuser
Configure the urls¶
Open the file urls.py in the myintranet/myintranet folder and there you can setup the URLs of your project. For example:
# -*- 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()
Temporary file folder¶
Just one more thing, for the feature of file import to work correctly, you need to use a temporary file folder. If it doesn’t work with the default value, please define FILE_UPLOAD_TEMP_DIR in your settings.
That’s it. You are now ready to run the server and use the application.