htsworkflow/frontend/settings.py

   1 """
   2 Generate settings for the Django Application.
   3
   4 To make it easier to customize the application the settings can be
   5 defined in a configuration file read by ConfigParser.
   6
   7 The options understood by this module are (with their defaults):
   8
   9   [frontend]
  10   email_host=localhost
  11   email_port=25
  12   database_engine=sqlite3
  13   database_name=/path/to/db
  14
  15   [admins]
  16   #name1=email1
  17
  18   [allowed_hosts]
  19   #name1=ip
  20   localhost=127.0.0.1
  21
  22   [allowed_analysis_hosts]
  23   #name1=ip
  24   localhost=127.0.0.1
  25
  26 """
  27 import ConfigParser
  28 import os
  29
  30 # make epydoc happy
  31 __docformat__ = "restructuredtext en"
  32
  33 def options_to_list(dest, section_name):
  34   """
  35   Load a options from section_name and store in a dictionary
  36   """
  37   if options.has_section(section_name):
  38     for name in options.options(section_name):
  39       dest.append( options.get(section_name, name) )
  40
  41 def options_to_dict(dest, section_name):
  42   """
  43   Load a options from section_name and store in a dictionary
  44   """
  45   if options.has_section(section_name):
  46     for name in options.options(section_name):
  47       dest[name] = options.get(section_name, name)
  48
  49 # define your defaults here
  50 options = ConfigParser.SafeConfigParser(
  51            { 'email_host': 'localhost',
  52              'email_port': '25',
  53              'database_engine': 'sqlite3',
  54              'database_name':
  55                os.path.abspath('/htsworkflow/htswfrontend/dev_fctracker.db'),
  56              'time_zone': 'America/Los_Angeles',
  57            })
  58
  59 options.read([os.path.expanduser("~/.htsworkflow.ini"),
  60               '/etc/htsworkflow.ini',])
  61
  62 # Django settings for elandifier project.
  63
  64 DEBUG = True
  65 TEMPLATE_DEBUG = DEBUG
  66
  67 ADMINS = []
  68 options_to_list(ADMINS, 'admins')
  69
  70 MANAGERS = ADMINS
  71
  72 EMAIL_HOST = options.get('frontend', 'email_host')
  73 EMAIL_PORT = int(options.get('frontend', 'email_port'))
  74
  75 # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'ado_mssql'.
  76 DATABASE_ENGINE = options.get('frontend', 'database_engine')
  77
  78 # Or path to database file if using sqlite3.
  79 DATABASE_NAME = options.get('frontend', 'database_name' )
  80 DATABASE_USER = ''             # Not used with sqlite3.
  81 DATABASE_PASSWORD = ''         # Not used with sqlite3.
  82 DATABASE_HOST = ''             # Set to empty string for localhost. Not used with sqlite3.
  83 DATABASE_PORT = ''             # Set to empty string for default. Not used with sqlite3.
  84
  85 # Local time zone for this installation. Choices can be found here:
  86 # http://www.postgresql.org/docs/8.1/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE
  87 # although not all variations may be possible on all operating systems.
  88 # If running in a Windows environment this must be set to the same as your
  89 # system time zone.
  90 TIME_ZONE = options.get('frontend', 'time_zone')
  91
  92 # Language code for this installation. All choices can be found here:
  93 # http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
  94 # http://blogs.law.harvard.edu/tech/stories/storyReader$15
  95 LANGUAGE_CODE = 'en-us'
  96
  97 SITE_ID = 1
  98
  99 # If you set this to False, Django will make some optimizations so as not
 100 # to load the internationalization machinery.
 101 USE_I18N = True
 102
 103 # Absolute path to the directory that holds media.
 104 # Example: "/home/media/media.lawrence.com/"
 105 MEDIA_ROOT = ''
 106
 107 # URL that handles the media served from MEDIA_ROOT.
 108 # Example: "http://media.lawrence.com"
 109 MEDIA_URL = ''
 110
 111 # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
 112 # trailing slash.
 113 # Examples: "http://foo.com/media/", "/media/".
 114 ADMIN_MEDIA_PREFIX = '/media/'
 115
 116 # Make this unique, and don't share it with anybody.
 117 SECRET_KEY = '(ekv^=gf(j9f(x25@a7r+8)hqlz%&_1!tw^75l%^041#vi=@4n'
 118
 119 # List of callables that know how to import templates from various sources.
 120 TEMPLATE_LOADERS = (
 121     'django.template.loaders.filesystem.load_template_source',
 122     'django.template.loaders.app_directories.load_template_source',
 123 #     'django.template.loaders.eggs.load_template_source',
 124 )
 125
 126 MIDDLEWARE_CLASSES = (
 127     'django.middleware.common.CommonMiddleware',
 128     'django.contrib.sessions.middleware.SessionMiddleware',
 129     'django.contrib.auth.middleware.AuthenticationMiddleware',
 130     'django.middleware.doc.XViewMiddleware',
 131 )
 132
 133 ROOT_URLCONF = 'htsworkflow.frontend.urls'
 134
 135 TEMPLATE_DIRS = (
 136     # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
 137     # Always use forward slashes, even on Windows.
 138     # Don't forget to use absolute paths, not relative paths.
 139     os.path.join(os.path.split(__file__)[0], 'templates'),
 140 )
 141
 142 INSTALLED_APPS = (
 143     'django.contrib.admin',
 144     'django.contrib.auth',
 145     'django.contrib.contenttypes',
 146     'django.contrib.humanize',
 147     'django.contrib.sessions',
 148     'django.contrib.sites',
 149     'htsworkflow.frontend.eland_config',
 150     'htsworkflow.frontend.samples',
 151     # modules from htsworkflow branch
 152     'htsworkflow.frontend.experiments',
 153     'htsworkflow.frontend.analysis',
 154     'htsworkflow.frontend.reports',
 155     'django.contrib.databrowse',
 156 )
 157
 158 # Project specific settings
 159
 160 ALLOWED_IPS={'localhost': '127.0.0.1'}
 161 options_to_dict(ALLOWED_IPS, 'allowed_hosts')
 162
 163 ALLOWED_ANALYS_IPS = {'localhost': '127.0.0.1'}
 164 options_to_dict(ALLOWED_ANALYS_IPS, 'allowed_analysis_hosts')
 165 #UPLOADTO_HOME = os.path.abspath('../../uploads')
 166 #UPLOADTO_CONFIG_FILE = os.path.join(UPLOADTO_HOME, 'eland_config')
 167 #UPLOADTO_ELAND_RESULT_PACKS = os.path.join(UPLOADTO_HOME, 'eland_results')
 168 #UPLOADTO_BED_PACKS = os.path.join(UPLOADTO_HOME, 'bed_packs')