Module conf

Loads global sofine configuration in from a configuration file. The file must be stored in the project root and must be called either sofine.conf or example.sofine.conf. If sofine.conf is found it will be used over example.sofine.conf.

Current supported configuration keys are:

"""Loads global sofine configuration in from a configuration file. The file must be stored 
in the project root and must be called either `sofine.conf` or `example.sofine.conf`. If 
`sofine.conf` is found it will be used over `example.sofine.conf`.

Current supported configuration keys are:

* `plugin_path` - The path to the user's plugins directory. This can be any reachable path 
that sofine has permission to read.
* `rest_port` - The port for running the sofine REST server under the `localhost` domain. 
The default value is `10000` defined in `example.sofine.conf`.
"""

import inspect
import sys
import json


# Add the plugins direcgory to the system path so the dynamic module load
#  finds any plugins in their and load_module just works
PLUGIN_BASE_PATH = '/'.join(inspect.stack()[0][1].split('/')[:-3]) + '/plugins'
sys.path.insert(0, PLUGIN_BASE_PATH) 


plugin_conf_path = '/'.join(inspect.stack()[0][1].split('/')[:-4])

plugin_conf = None
CUSTOM_PLUGIN_BASE_PATH = None
"""The user-defined plugin directory. The idea is that users of sofine simply install the 
library, configure this value, and then can deploy, version control, write tests for and 
otherwise manage their plugins in a separate directory, which sofine CLI and REST calls 
transparently look in to load plugins. This value is defined in the JSON configuration file 
`sofine.conf` under the key `plugin_path`.
"""
REST_PORT = None
"""The port for running the sofine REST server under the `localhost` domain. This value 
is defined in the JSON configuration file `sofine.conf` under the key `rest_port`. The default 
value is defined in `example.sofine.conf` and will be used if the user doesn't override it in 
`sofine.conf`.
"""
try:
    plugin_conf = json.load(open(plugin_conf_path + '/sofine.conf'))
except:
    pass

if not plugin_conf:
    try:
        plugin_conf = json.load(open(plugin_conf_path + '/example.sofine.conf'))
    except:
        pass

if plugin_conf:
    CUSTOM_PLUGIN_BASE_PATH = plugin_conf['plugin_path']
    sys.path.insert(0, CUSTOM_PLUGIN_BASE_PATH) 
    REST_PORT = plugin_conf['rest_port']

Module variables

var CUSTOM_PLUGIN_BASE_PATH

The user-defined plugin directory. The idea is that users of sofine simply install the library, configure this value, and then can deploy, version control, write tests for and otherwise manage their plugins in a separate directory, which sofine CLI and REST calls transparently look in to load plugins. This value is defined in the JSON configuration file sofine.conf under the key plugin_path.

var PLUGIN_BASE_PATH

var REST_PORT

The port for running the sofine REST server under the localhost domain. This value is defined in the JSON configuration file sofine.conf under the key rest_port. The default value is defined in example.sofine.conf and will be used if the user doesn't override it in sofine.conf.

var plugin_conf

var plugin_conf_path


Documentation generated by pdoc 0.2.4. pdoc is in the public domain with the UNLICENSE.