2 Generate settings for the Django Application.
4 To make it easier to customize the application the settings can be
5 defined in a configuration file read by ConfigParser.
7 The options understood by this module are (with their defaults):
12 database_engine=sqlite3
13 database_name=/path/to/db
22 [allowed_analysis_hosts]
32 __docformat__ = "restructuredtext en"
34 def options_to_list(options, dest, section_name, option_name):
36 Load a options from section_name and store in a dictionary
38 if options.has_option(section_name, option_name):
39 opt = options.get(section_name, option_name)
40 dest.extend( shlex.split(opt) )
42 def options_to_dict(dest, section_name):
44 Load a options from section_name and store in a dictionary
46 if options.has_section(section_name):
47 for name in options.options(section_name):
48 dest[name] = options.get(section_name, name)
50 # define your defaults here
51 options = ConfigParser.SafeConfigParser(
52 { 'email_host': 'localhost',
54 'database_engine': 'sqlite3',
56 os.path.abspath('../../fctracker.db'),
57 'time_zone': 'America/Los_Angeles',
59 'link_flowcell_storage_device_url': "http://localhost:8000/inventory/lts/link/",
60 'printer1_host': '127.0.0.1',
61 'printer1_port': '9100',
62 'printer2_host': '127.0.0.1',
63 'printer2_port': '9100',
66 options.read([os.path.expanduser("~/.htsworkflow.ini"),
67 '/etc/htsworkflow.ini',])
69 # OptionParser will use the dictionary passed into the config parser as
70 # 'Default' values in any section. However it still needs an empty section
71 # to exist in order to retrieve anything.
72 if not options.has_section('frontend'):
73 options.add_section('frontend')
74 if not options.has_section('bcprinter'):
75 options.add_section('bcprinter')
78 # Django settings for elandifier project.
81 TEMPLATE_DEBUG = DEBUG
84 options_to_list(options, ADMINS, 'frontend', 'admins')
87 options_to_list(options, MANAGERS, 'frontend', 'managers')
89 DEFAULT_PM=int(options.get('frontend', 'default_pm'))
91 AUTHENTICATION_BACKENDS = (
92 'htsworkflow.frontend.samples.auth_backend.HTSUserModelBackend', )
93 CUSTOM_USER_MODEL = 'samples.HTSUser'
95 EMAIL_HOST = options.get('frontend', 'email_host')
96 EMAIL_PORT = int(options.get('frontend', 'email_port'))
98 if options.has_option('frontend', 'notification_sender'):
99 NOTIFICATION_SENDER = options.get('frontend', 'notification_sender')
101 NOTIFICATION_SENDER = "noreply@example.com"
102 NOTIFICATION_BCC = []
103 options_to_list(options, NOTIFICATION_BCC, 'frontend', 'notification_bcc')
105 # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'ado_mssql'.
106 DATABASE_ENGINE = options.get('frontend', 'database_engine')
108 # Or path to database file if using sqlite3.
109 DATABASE_NAME = options.get('frontend', 'database_name' )
110 DATABASE_USER = '' # Not used with sqlite3.
111 DATABASE_PASSWORD = '' # Not used with sqlite3.
112 DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3.
113 DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3.
115 # Local time zone for this installation. Choices can be found here:
116 # http://www.postgresql.org/docs/8.1/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE
117 # although not all variations may be possible on all operating systems.
118 # If running in a Windows environment this must be set to the same as your
120 TIME_ZONE = options.get('frontend', 'time_zone')
122 # Language code for this installation. All choices can be found here:
123 # http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
124 # http://blogs.law.harvard.edu/tech/stories/storyReader$15
125 LANGUAGE_CODE = 'en-us'
129 # If you set this to False, Django will make some optimizations so as not
130 # to load the internationalization machinery.
133 # Absolute path to the directory that holds media.
134 # Example: "/home/media/media.lawrence.com/"
135 MEDIA_ROOT = os.path.abspath(os.path.split(__file__)[0]) + '/static/'
137 # URL that handles the media served from MEDIA_ROOT.
138 # Example: "http://media.lawrence.com"
139 MEDIA_URL = '/static/'
141 # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
143 # Examples: "http://foo.com/media/", "/media/".
144 ADMIN_MEDIA_PREFIX = '/media/'
146 # Make this unique, and don't share it with anybody.
147 SECRET_KEY = '(ekv^=gf(j9f(x25@a7r+8)hqlz%&_1!tw^75l%^041#vi=@4n'
149 # some of our urls need an api key
150 DEFAULT_API_KEY = 'n7HsXGHIi0vp9j5u4TIRJyqAlXYc4wrH'
152 # List of callables that know how to import templates from various sources.
154 'django.template.loaders.filesystem.load_template_source',
155 'django.template.loaders.app_directories.load_template_source',
156 # 'django.template.loaders.eggs.load_template_source',
159 MIDDLEWARE_CLASSES = (
160 'django.middleware.common.CommonMiddleware',
161 'django.contrib.sessions.middleware.SessionMiddleware',
162 'django.contrib.auth.middleware.AuthenticationMiddleware',
163 'django.middleware.doc.XViewMiddleware',
166 ROOT_URLCONF = 'htsworkflow.frontend.urls'
169 # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
170 # Always use forward slashes, even on Windows.
171 # Don't forget to use absolute paths, not relative paths.
172 '/usr/share/python-support/python-django/django/contrib/admin/templates',
173 #'/usr/lib/pymodules/python2.6/django/contrib/admin/templates/',
174 os.path.join(os.path.split(__file__)[0],
175 'htsworkflow', 'frontend','templates'),
179 'django.contrib.admin',
180 'django.contrib.auth',
181 'django.contrib.contenttypes',
182 'django.contrib.humanize',
183 'django.contrib.sessions',
184 'django.contrib.sites',
185 'htsworkflow.frontend.eland_config',
186 'htsworkflow.frontend.samples',
187 # modules from htsworkflow branch
188 'htsworkflow.frontend.experiments',
189 'htsworkflow.frontend.analysis',
190 'htsworkflow.frontend.reports',
191 'htsworkflow.frontend.inventory',
192 'htsworkflow.frontend.bcmagic',
193 'django.contrib.databrowse',
196 # Project specific settings
198 ALLOWED_IPS={'127.0.0.1': '127.0.0.1'}
199 options_to_dict(ALLOWED_IPS, 'allowed_hosts')
201 ALLOWED_ANALYS_IPS = {'127.0.0.1': '127.0.0.1'}
202 options_to_dict(ALLOWED_ANALYS_IPS, 'allowed_analysis_hosts')
203 #UPLOADTO_HOME = os.path.abspath('../../uploads')
204 #UPLOADTO_CONFIG_FILE = os.path.join(UPLOADTO_HOME, 'eland_config')
205 #UPLOADTO_ELAND_RESULT_PACKS = os.path.join(UPLOADTO_HOME, 'eland_results')
206 #UPLOADTO_BED_PACKS = os.path.join(UPLOADTO_HOME, 'bed_packs')
207 # Where "results_dir" means directory with all the flowcells
208 if options.has_option('frontend', 'results_dir'):
209 RESULT_HOME_DIR=os.path.expanduser(options.get('frontend', 'results_dir'))
211 RESULT_HOME_DIR='/tmp'
213 LINK_FLOWCELL_STORAGE_DEVICE_URL = options.get('frontend', 'link_flowcell_storage_device_url')
214 # PORT 9100 is default for Zebra tabletop/desktop printers
215 # PORT 6101 is default for Zebra mobile printers
216 BCPRINTER_PRINTER1_HOST = options.get('bcprinter', 'printer1_host')
217 BCPRINTER_PRINTER1_PORT = int(options.get('bcprinter', 'printer1_port'))
218 BCPRINTER_PRINTER2_HOST = options.get('bcprinter', 'printer2_host')
219 BCPRINTER_PRINTER2_PORT = int(options.get('bcprinter', 'printer2_port'))