https://github.com/mrtazz/towbar
Python API wrapper for boxcar.io
https://github.com/mrtazz/towbar
Last synced: over 1 year ago
JSON representation
Python API wrapper for boxcar.io
- Host: GitHub
- URL: https://github.com/mrtazz/towbar
- Owner: mrtazz
- License: mit
- Created: 2011-09-10T21:04:25.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2012-03-08T03:41:08.000Z (over 14 years ago)
- Last Synced: 2025-01-25T23:17:18.216Z (over 1 year ago)
- Language: Python
- Homepage: http://readthedocs.org/docs/towbar/en/latest/api.html
- Size: 113 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- License: LICENSE
Awesome Lists containing this project
README
==============
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
=============
* `python-requests `_
TODO
=====
* Full API support
* Provider support
* Integration testing
Meta
======
* `Bugs `_
* `Continuous Integration `_
* `Docs `_
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.
.. _boxcar.io: http://boxcar.io