Metadata-Version: 2.0
Name: jointbox
Version: 0.1.2
Summary: Your DIY smart house. Simplified.
Home-page: http://jointbox.org
Author: Dmitry Berezovsky
Author-email: UNKNOWN
License: GPLv3
Description-Content-Type: UNKNOWN
Keywords: home automation smarthouse arduino gpio sensors hardware temperature relay
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: PyYAML (==3.11)
Requires-Dist: paho-mqtt (==1.1)
Requires-Dist: typing (==3.5.3.0)
Requires-Dist: numpy (==1.12.0)
Requires-Dist: daemons (==1.3.0)
Requires-Dist: smbus2 (==0.1.4)
Provides-Extra: dev
Provides-Extra: test

Joint Box
=========

TBD

Development
-----------

First of all ensure you have all prerequisites:

1. Python >=3.5
2. Virtual Environment tool (virtualenv)

Then follow procedure described below to prepare environment for development:

1. Checkout git repository: ``git clone https://github.com/JointBox/jointbox.git``. Open terminal and change dir to the project root.
2. Create virtual environment: ``virtualenv virtualenv``. Activate it: ``source ./virtualenv/bin/activate``
3. Install development requirements: ``pip install -r requirements.txt``
4. Configure hooks: ``cd .git/hooks && ln -s ../../development/pre-commit-hook.sh pre-commit && cd ../..``
5. Install application as a package in dev mode: ``cd src && ./setup.py sdist``
6. Validate your setup:
    * Check if ``jointbox`` and ``jointboxd`` executables are in the context
    * Run ``jointbox -h`` and insure that output doesn't contain exceptions


Development procedures
``````````````````````

Ensure that all python sources contain license notice:

: code:: bash
    ./development/copyright-update

In order to run suplementary services under docker you may use predefined docker-compose config:

: code:: bash
    cd ./development/docker
    docker-compose up -d

