Add default settings and update documentation

2 files changed, 186 insertions, 1 deletions

diff --git a/example_project/.gitignore b/example_project/.gitignore
deleted file mode 100644
index fce19e421..000000000
--- a/example_project/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-settings.py
diff --git a/example_project/settings.py b/example_project/settings.py
new file mode 100644
index 000000000..f8d188b23
--- /dev/null
+++ b/example_project/settings.py
@@ -0,0 +1,186 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Django settings for ishtar project.
+
+import os
+
+# Ishtar custom
+SRID = 27572
+ENCODING = 'windows-1252'
+APP_NAME = "SRA - Pays de la Loire"
+SURFACE_UNIT = 'square-metre'
+SURFACE_UNIT_LABEL = u'm²'
+JOINT = u" - "
+
+ROOT_PATH = os.path.abspath(os.path.curdir) + os.path.sep
+STATIC_URL = '/static/'
+STATIC_ROOT = ROOT_PATH + 'static/'
+
+URL_PATH = ""
+JQUERY_URL = "http://localhost/javascript/jquery/jquery.js"
+JQUERY_UI_URL = "http://localhost/javascript/jquery-ui/"
+XHTML2ODT_PATH = ROOT_PATH + "../xhtml2odt"
+ODT_TEMPLATE = ROOT_PATH + "../static/template.odt"
+
+LOGIN_REDIRECT_URL = "/" + URL_PATH
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+TEST_RUNNER='django.contrib.gis.tests.run_tests'
+
+AUTH_PROFILE_MODULE = 'ishtar_common.IshtarUser'
+
+# 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'
+
+COUNTRY = "fr"
+
+SITE_ID = 1
+
+# 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
+
+# Absolute path to the directory that holds media.
+# Example: "/home/media/media.lawrence.com/"
+MEDIA_ROOT = ROOT_PATH + 'media/'
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash if there is a path component (optional in other cases).
+# Examples: "http://media.lawrence.com", "http://example.com/media/"
+MEDIA_URL = '/media/'
+
+# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
+# trailing slash.
+# Examples: "http://foo.com/media/", "/media/".
+ADMIN_MEDIA_PREFIX = '/media/'
+
+# 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',
+)
+
+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',
+    #'debug_toolbar.middleware.DebugToolbarMiddleware',
+)
+
+TEMPLATE_CONTEXT_PROCESSORS = (
+    'ishtar_common.context_processors.get_base_context',
+    "django.contrib.auth.context_processors.auth",
+    "django.core.context_processors.debug",
+    "django.core.context_processors.i18n",
+    "django.core.context_processors.media",
+)
+
+ROOT_URLCONF = 'example_project.urls'
+
+TEMPLATE_DIRS = (
+    ROOT_PATH + 'templates',
+)
+
+AUTHENTICATION_BACKENDS = (
+    'django.contrib.auth.backends.ModelBackend',
+    'ishtar_common.backend.ObjectOwnPermBackend',
+)
+
+INSTALLED_APPS = [
+    'django.contrib.auth',
+    'django.contrib.admin',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.gis',
+    'django.contrib.staticfiles',
+    'django.contrib.formtools',
+    'south',
+    'registration',
+    'ishtar_common',
+    'archaeological_operations', # mandatory app to run ishtar
+    'django_extensions',
+    #'debug_toolbar',
+]
+
+LOGGING = {'version': 1,
+     'disable_existing_loggers': False,
+    'handlers': {
+        # Include the default Django email handler for errors
+        # This is what you'd get without configuring logging at all.
+        'mail_admins': {
+            'class': 'django.utils.log.AdminEmailHandler',
+            'level': 'ERROR',
+            # But the emails are plain text by default - HTML is nicer
+            'include_html': True,
+        },
+        # Log to a text file that can be rotated by logrotate
+        'logfile': {
+            'class': 'logging.handlers.WatchedFileHandler',
+            'filename': '/var/log/django/ishtar.log'
+        },
+    },
+    'loggers': {
+        # Again, default Django configuration to email unhandled exceptions
+        'django.request': {
+            'handlers': ['mail_admins'],
+            'level': 'ERROR',
+            'propagate': True,
+        },
+        # Might as well log any errors anywhere else in Django
+        'django': {
+            'handlers': ['logfile'],
+            'level': 'ERROR',
+            'propagate': False,
+        },
+        # Your own app - this assumes all your logger names start with "myapp."
+        'chimere': {
+            'handlers': ['logfile'],
+            'level': 'WARNING', # Or maybe INFO or DEBUG
+                'propogate': False
+        },
+    },
+}
+
+try:
+    from local_settings import *
+except ImportError, e:
+    print 'Unable to load local_settings.py:', e
+
+if 'archaeological_files' in EXTRA_APPS:
+    EXTRA_APPS.pop(EXTRA_APPS.index('archaeological_files'))
+    INSTALLED_APPS.insert(INSTALLED_APPS.index('archaeological_operations'),
+                          'archaeological_files')
+
+INSTALLED_APPS += EXTRA_APPS
+
+INTERNAL_IPS = ('127.0.0.1',)
+
+DEBUG_TOOLBAR_PANELS = (
+    'debug_toolbar.panels.version.VersionDebugPanel',
+    'debug_toolbar.panels.timer.TimerDebugPanel',
+    'debug_toolbar.panels.headers.HeaderDebugPanel',
+    'debug_toolbar.panels.request_vars.RequestVarsDebugPanel',
+    'debug_toolbar.panels.sql.SQLDebugPanel',
+    'debug_toolbar.panels.cache.CacheDebugPanel',
+    'debug_toolbar.panels.logger.LoggingPanel',
+)
+
+DEBUG_TOOLBAR_CONFIG = {'INTERCEPT_REDIRECTS':False}