Metadata-Version: 1.1
Name: braubuddy
Version: 0.3.0
Summary: An extensile thermostat framework
Home-page: http://braubuddy.org/
Author: James Stewart
Author-email: jstewart101@gmail.com
License: LICENSE.txt
Description: |logo| Braubuddy
        ================
        
        |travis|
        
        *Braubuddy* is a temperature management framework written in Python.
        
        Conceived as a means of monitoring and controlling the fermentation temperature of beer, *Braubuddy* can be used in any situation requiring precise temperature control:
        
        - Keep tropical fish swimming happily in water that's 26°C 
        - Brew a perfect lager by fermenting at a constant 9°C
        - Maximise employee productivity with an optimum office ambient air temp of 21.5°C
        
        Complete documentation is available at `braubuddy.org <http://braubuddy.org>`_.
        
        Features
        --------
        
        Web Interface
        ^^^^^^^^^^^^^
        
        *Braubuddy*'s web interface facilitates temperature monitoring from any device with a web browser.
        
        |web_interface|
        
        API
        ^^^
        
        Time-series temperature, heating and cooling metrics may be consumed programatically using the *Braubuddy* API.
        
        Outputs
        ^^^^^^^
        
        *Braubuddy* outputs allow metric values to be recorded in a variety of formats or published directly to external services.
        
        Extensible
        ^^^^^^^^^^
        
        The various *Braubuddy* components are designed to be extended. Consult ``CONTRIBUTE.RST`` if you'd like to request or contribute support for a particular component.
        
        Getting Started
        ---------------
        
        Hardware
        ^^^^^^^^
        
        To monitor temperature using *Braubuddy* you will need a supported `thermometer <http://braubuddy.org/components.html#thermometer>`_.
        
        To control temperature you will also need a supported `environmental controller <http://braubuddy.org/components.html#envcontroller>`_.
        
        Install
        ^^^^^^^
        
        *Braubuddy* is best enjoyed from within a Python `virtualenv <http://virtualenv.readthedocs.org/en/latest/>`_:
        
        ::
        
            virtualenv ~/braubuddy
            source ~/braubuddy/bin/activate
        
        Production
        ~~~~~~~~~~
        
        Install the latest production release from `PyPI <https://pypi.python.org/>`_ using `pip <http://www.pip-installer.org/>`_:
        
        ::
        
            pip install braubuddy
        
        Development
        ~~~~~~~~~~~
        
        Install the latest development release from `Github <https://github.com/amorphic/braubuddy>`_:
        
        ::
        
            git clone https://github.com/amorphic/braubuddy.git
            pip install -e ./braubuddy
        
        Start
        ^^^^^
        
        Start braubuddy with a single command:
        
        ::
        
            braubuddy
        
        Configure
        ^^^^^^^^^
        
        If not already present, a default configuration file is deployed to ``~/.config/braubuddy/``.
        
        For system-wide configuration, copy this config file to ``/etc/xdg/braubuddy/``.
        
        The example config file use default targets and automatically attempts to find a compatible thermometer and environmental controller. Follow `the docs <http://braubuddy.org/configure.html>`_ to customise your configuration. 
        
        
        .. |travis| image:: https://travis-ci.org/amorphic/braubuddy.svg?branch=master
          :alt: Braubuddy CI
          :target: https://travis-ci.org/amorphic/braubuddy
        
        .. |logo| image:: images/logo/bb_logo_24x24.png
          :alt: Braubuddy web application
          :target: https://braubuddy.org
        
        .. |web_interface| image:: /images/screenshots/1.png
          :alt: Braubuddy web application
          :target: https://braubuddy.org
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
