Metadata-Version: 1.1
Name: python-boatdclient
Version: 0.2.0
Summary: Python wrapper for the boatd API, used to write behavior scripts.
Home-page: https://github.com/boatd/python-boatd
Author: Louis Taylor
Author-email: louis@kragniz.eu
License: GPL
Description: ============
        python-boatd
        ============
        
        .. image:: https://badge.fury.io/py/boatd_client.svg
            :target: http://badge.fury.io/py/boatd_client
        
        .. image:: https://travis-ci.org/boatd/python-boatd.png?branch=master
            :target: https://travis-ci.org/boatd/python-boatd
        
        Python module for writing `boatd <https://github.com/boatd/boatd>`_ behavior
        scripts.
        
        Installing
        ==========
        
        ``$ pip install boatd_client``
        
        class **Boat**
        ==============
        
        A boat controlled by boatd
        
        
        **Attributes**
        ----------------
        
        ``heading``:
        Return the current heading of the boat in degrees
        
        ``position``:
        Return a tuple in the form ``(latitude, longitude)``
        
        ``version``:
        Return the version of boatd
        
        ``wind``:
        Return a tuple in the form ``(direction, speed)``. This contains the direction of the wind in degrees and the speed the wind is blowing in knots.
        
        **methods**
        -----------
        
        ``def __init__(self, host='localhost', port=2222)``
        
        Create a boat instance, connecting to boatd at ``host`` on port ``port``
        
        ``def __rudder__(self, angle)``
        
        Set the angle of the rudder to be ``angle`` degrees
        
        ``def __sail__(self, angle)``
        
        Set the angle of the sail to ``angle`` degrees
        
        
Keywords: boat sailing wrapper rest
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
