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              'default_pm': '5',
  58              'link_flowcell_storage_device_url': "http://localhost:8000/inventory/lts/link/",
  59              'printer1_host': '127.0.0.1',
  60              'printer1_port': '9100',
  61              'printer2_host': '127.0.0.1',
  62              'printer2_port': '9100',
  63            })
  64
  65 options.read([os.path.expanduser("~/.htsworkflow.ini"),
  66               '/etc/htsworkflow.ini',])
  67
  68 # OptionParser will use the dictionary passed into the config parser as
  69 # 'Default' values in any section. However it still needs an empty section
  70 # to exist in order to retrieve anything.
  71 if not options.has_section('frontend'):
  72     options.add_section('frontend')
  73 if not options.has_section('bcprinter'):
  74     options.add_section('bcprinter')
  75
  76
  77 # Django settings for elandifier project.
  78
  79 DEBUG = True
  80 TEMPLATE_DEBUG = DEBUG
  81
  82 ADMINS = []
  83 options_to_list(ADMINS, 'admins')
  84
  85 MANAGERS = ADMINS
  86
  87 AUTHENTICATION_BACKENDS = ( 'samples.auth_backend.HTSUserModelBackend', )
  88 CUSTOM_USER_MODEL = 'samples.HTSUser'
  89
  90 EMAIL_HOST = options.get('frontend', 'email_host')
  91 EMAIL_PORT = int(options.get('frontend', 'email_port'))
  92
  93 # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'ado_mssql'.
  94 DATABASE_ENGINE = options.get('frontend', 'database_engine')
  95
  96 # Or path to database file if using sqlite3.
  97 DATABASE_NAME = options.get('frontend', 'database_name' )
  98 DATABASE_USER = ''             # Not used with sqlite3.
  99 DATABASE_PASSWORD = ''         # Not used with sqlite3.
 100 DATABASE_HOST = ''             # Set to empty string for localhost. Not used with sqlite3.
 101 DATABASE_PORT = ''             # Set to empty string for default. Not used with sqlite3.
 102
 103 # Local time zone for this installation. Choices can be found here:
 104 # http://www.postgresql.org/docs/8.1/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE
 105 # although not all variations may be possible on all operating systems.
 106 # If running in a Windows environment this must be set to the same as your
 107 # system time zone.
 108 TIME_ZONE = options.get('frontend', 'time_zone')
 109
 110 # Language code for this installation. All choices can be found here:
 111 # http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
 112 # http://blogs.law.harvard.edu/tech/stories/storyReader$15
 113 LANGUAGE_CODE = 'en-us'
 114
 115 SITE_ID = 1
 116
 117 # If you set this to False, Django will make some optimizations so as not
 118 # to load the internationalization machinery.
 119 USE_I18N = True
 120
 121 # Absolute path to the directory that holds media.
 122 # Example: "/home/media/media.lawrence.com/"
 123 MEDIA_ROOT = os.path.abspath(os.path.split(__file__)[0]) + '/static/'
 124
 125 # URL that handles the media served from MEDIA_ROOT.
 126 # Example: "http://media.lawrence.com"
 127 MEDIA_URL = '/static/'
 128
 129 # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
 130 # trailing slash.
 131 # Examples: "http://foo.com/media/", "/media/".
 132 ADMIN_MEDIA_PREFIX = '/media/'
 133
 134 # Make this unique, and don't share it with anybody.
 135 SECRET_KEY = '(ekv^=gf(j9f(x25@a7r+8)hqlz%&_1!tw^75l%^041#vi=@4n'
 136
 137 # List of callables that know how to import templates from various sources.
 138 TEMPLATE_LOADERS = (
 139     'django.template.loaders.filesystem.load_template_source',
 140     'django.template.loaders.app_directories.load_template_source',
 141 #     'django.template.loaders.eggs.load_template_source',
 142 )
 143
 144 MIDDLEWARE_CLASSES = (
 145     'django.middleware.common.CommonMiddleware',
 146     'django.contrib.sessions.middleware.SessionMiddleware',
 147     'django.contrib.auth.middleware.AuthenticationMiddleware',
 148     'django.middleware.doc.XViewMiddleware',
 149 )
 150
 151 ROOT_URLCONF = 'htsworkflow.frontend.urls'
 152
 153 TEMPLATE_DIRS = (
 154     # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
 155     # Always use forward slashes, even on Windows.
 156     # Don't forget to use absolute paths, not relative paths.
 157     os.path.join(os.path.split(__file__)[0], 'templates'),
 158 )
 159
 160 INSTALLED_APPS = (
 161     'django.contrib.admin',
 162     'django.contrib.auth',
 163     'django.contrib.contenttypes',
 164     'django.contrib.humanize',
 165     'django.contrib.sessions',
 166     'django.contrib.sites',
 167     'htsworkflow.frontend.eland_config',
 168     'htsworkflow.frontend.samples',
 169     # modules from htsworkflow branch
 170     'htsworkflow.frontend.experiments',
 171     'htsworkflow.frontend.analysis',
 172     'htsworkflow.frontend.reports',
 173     'htsworkflow.frontend.inventory',
 174     'htsworkflow.frontend.bcmagic',
 175     'htsworkflow.frontend.bcprinter',
 176     'django.contrib.databrowse',
 177 )
 178
 179 # Project specific settings
 180
 181 ALLOWED_IPS={'127.0.0.1': '127.0.0.1'}
 182 options_to_dict(ALLOWED_IPS, 'allowed_hosts')
 183
 184 ALLOWED_ANALYS_IPS = {'127.0.0.1': '127.0.0.1'}
 185 options_to_dict(ALLOWED_ANALYS_IPS, 'allowed_analysis_hosts')
 186 #UPLOADTO_HOME = os.path.abspath('../../uploads')
 187 #UPLOADTO_CONFIG_FILE = os.path.join(UPLOADTO_HOME, 'eland_config')
 188 #UPLOADTO_ELAND_RESULT_PACKS = os.path.join(UPLOADTO_HOME, 'eland_results')
 189 #UPLOADTO_BED_PACKS = os.path.join(UPLOADTO_HOME, 'bed_packs')
 190 RESULT_HOME_DIR='/Users/diane/proj/solexa/results/flowcells'
 191
 192 LINK_FLOWCELL_STORAGE_DEVICE_URL = options.get('frontend', 'link_flowcell_storage_device_url')
 193 # PORT 9100 is default for Zebra tabletop/desktop printers
 194 # PORT 6101 is default for Zebra mobile printers
 195 BCPRINTER_PRINTER1_HOST = options.get('bcprinter', 'printer1_host')
 196 BCPRINTER_PRINTER1_PORT = int(options.get('bcprinter', 'printer1_port'))
 197 BCPRINTER_PRINTER2_HOST = options.get('bcprinter', 'printer2_host')
 198 BCPRINTER_PRINTER2_PORT = int(options.get('bcprinter', 'printer2_port'))