diff --git a/doc/source/installation.rst b/doc/source/installation.rst index ed317cf..4ac8fab 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -10,16 +10,40 @@ Environment Installation ============ +Since there is no stable release yet, the only option is to install the project from the source. -1. Install http://github.com/tendrl/bridge_common -2. Install http://github.com/tendrl/gluster_bridge +Development version from the source +----------------------------------- - At the command line:: +1. Install http://github.com/tendrl/bridge_common from the source code:: + + $ git clone https://github.com/Tendrl/bridge_common.git + $ cd bridge_common + $ mkvirtualenv bridge_common + $ pip install . + +2. Install gluster_bridge itself:: + $ git clone https://github.com/shtripat/gluster_bridge.git + $ cd gluster_bridge + $ workon gluster_bridge + $ pip install . + +Note that we use virtualenvwrapper_ here to activate ``gluster_bridge`` `python +virtual enviroment`_. This way, we install *gluster bridge* into the same virtual +enviroment which we have created during installation of *bridge common*. + +.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/ +.. _`python virtual enviroment`: https://virtualenv.pypa.io/en/stable/ + +3. Create config file:: - $ python setup.py install $ cp etc/tendrl/tendrl.conf.sample /etc/tendrl/tendrl.conf -4. Edit /etc/tendrl/tendrl.conf as required -5. mkdir /var/log/tendrl -6. Run - $ tendrl-gluster-bridge \ No newline at end of file +4. Edit ``/etc/tendrl/tendrl.conf`` as required + +5. Create log dir:: + + $ mkdir /var/log/tendrl + +6. Run:: + $ tendrl-gluster-bridge diff --git a/setup.py b/setup.py index 677f02e..79e13ed 100644 --- a/setup.py +++ b/setup.py @@ -20,8 +20,10 @@ def extract_requirements(filename): license="LGPL-2.1+", zip_safe=False, install_requires=install_requires, - entry_points={'console_scripts': [ - 'tendrl-gluster-bridge = tendrl.gluster_bridge.manager.manager:main' + entry_points={ + 'console_scripts': [ + 'tendrl-gluster-bridge = ' + 'tendrl.gluster_bridge.manager.manager:main' ] } ) diff --git a/tendrl/gluster_bridge/log.py b/tendrl/gluster_bridge/log.py index af9e213..414df6e 100644 --- a/tendrl/gluster_bridge/log.py +++ b/tendrl/gluster_bridge/log.py @@ -11,5 +11,11 @@ def setup_logging(): handler.setFormatter(logging.Formatter(FORMAT)) root.addHandler(handler) root.setLevel( - logging.getLevelName(config.get('gluster_bridge', 'log_level'))) + logging.getLevelName( + config.get( + 'gluster_bridge', + 'log_level' + ) + ) + ) logging.getLogger(__name__).info("Logging setup complete!")