Python Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
tests/unit
towbar
.gitignore
HISTORY.rst
LICENSE
MANIFEST
MANIFEST.in
README.rst
reqs.txt
reqs_testing.txt
setup.py
tox.ini

README.rst

towbar

Introduction

towbar is a python library for the boxcar.io web service.

Installation

Install via pip:

pip install towbar

Or if you must:

easy_install towbar

Usage

towbar can be imported into any python module:

from towbar import Towbar
tow_bar = Towbar(user, password)

The object then provides the following API methods:

tow_bar.notify_myself(message, sender)

There is also an exported API function which can be used directly:

import towbar
towbar.send_notification(user, password, text)

Dependencies

TODO

  • Full API support
  • Provider support
  • Integration testing

Meta

Contribute

If you want to contribute:

  • Fork the project.
  • Make your feature addition or bug fix based on develop.
  • Add tests for it. This is important so I don’t break it in a future version unintentionally.
  • Commit, do not mess with version
  • Send me a pull request. Bonus points for topic branches.