Browse Source

add comments to __init__.py

* add comments
* add licence-header
Thomas Pointhuber 10 years ago
parent
commit
bc30c4f4ad
1 changed files with 20 additions and 0 deletions
  1. 20 0
      searx/__init__.py

+ 20 - 0
searx/__init__.py

@@ -1,3 +1,20 @@
+'''
+searx is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+searx is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with searx. If not, see < http://www.gnu.org/licenses/ >.
+
+(C) 2013- by Adam Tauber, <asciimoo@gmail.com>
+'''
+
 from os import environ
 from os.path import realpath, dirname, join, abspath
 try:
@@ -10,11 +27,14 @@ except:
 searx_dir = abspath(dirname(__file__))
 engine_dir = dirname(realpath(__file__))
 
+# if possible set path to settings using the enviroment variable SEARX_SETTINGS_PATH
 if 'SEARX_SETTINGS_PATH' in environ:
     settings_path = environ['SEARX_SETTINGS_PATH']
+# otherwise using default path
 else:
     settings_path = join(searx_dir, 'settings.yml')
 
 
+# load settings
 with open(settings_path) as settings_yaml:
     settings = load(settings_yaml)