Homebrain

Control and monitor your home on your own terms.

Usage

Installation

Download/clone the project and install it with pip3 install ./ (packages will be available at a later date).

If you are going to develop you might want to run pip3 install -e ./ instead (Why?).

Running it

Once you've installed it, simply run with homebrain.

Development

There is a Slack for team communication and a Trello board for planning.

Documentation

There is currently no pre-built documentation, but you can easily build it yourself by installing sphinx and sphinx-autodoc-typehints:

sudo pip3 install sphinx sphinx-autodoc-typehints

You can then build the docs by entering the docs folder and running:

python3 -m sphinx -b html . _build

You will then find the built docs in docs/_build/index.html.

Tests

The most convenient way to run the tests is with nose. Install with pip3 install nose and run with nosetests from the root directory of the project.

Tests are run automatically on Codeship (see the badge near the top of the README).

Copyright (c) 2015 The Homebrain Developers, released under the MIT license.