/curb_energy

A Python library for interacting with the Curb API

Primary LanguagePythonApache License 2.0Apache-2.0

curb_energy

https://travis-ci.org/ginoledesma/curb_energy.svg?branch=develop Documentation Status

A Python library to interact with the Curb API built on top of asyncio and aiohttp.

Documentation: http://curb-energy.readthedocs.io/en/latest/

Disclaimer

This project is not affiliated with Curb Inc.. Curb maintains a github repository of various projects and documents their API, which is built upon HAL.

I wanted something more pythonic than using HAL-tools to consume the API, and it was also a good opportunity for experimenting with using asyncio and aiohttp for handling streaming data.

Requirements

curb_energy requires Python 3.5 or later, mostly due to the async and type hint syntax used in the library.

Installation

curb_energy can be installed using pip, easy_install or setup.py

pip install curb_energy

You may want to install the library in a virtual environment to test things out.

License

curb_energy is offered under the Apache License 2.0.