Metadata-Version: 2.0
Name: webhooks
Version: 0.3.0
Summary: Python + Webhooks mMade Easy
Home-page: https://github.com/pydanny/webhooks
Author: Daniel Greenfeld
Author-email: pydanny@gmail.com
License: BSD
Keywords: webhooks
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: wrapt
Requires-Dist: requests (>=2.2.1)

===============================
webhooks
===============================

.. image:: https://pypip.in/d/webhooks/badge.png
        :target: https://pypi.python.org/pypi/webhooks

.. image:: https://badge.fury.io/py/webhooks.png
    :target: https://badge.fury.io/py/webhooks

.. image:: https://travis-ci.org/pydanny/webhooks.png
   :alt: Build Status
   :target: https://travis-ci.org/pydanny/webhooks

.. image:: https://pypip.in/wheel/webhooks/badge.png
    :target: https://pypi.python.org/pypi/webhooks/
    :alt: Wheel Status

Python + Webhooks Made Easy

* Free software: BSD license
* Documentation: http://webhooks.rtfd.org.

**WARNING** This project is in a pre-alpha state. It's not ready for use on ANYTHING.

Python Versions
----------------

Currently works in:

    * Python 2.7
    * Python 3.3
    * PyPy

Existing Features
------------------

* Easy to integrate into any package or project
* Comes with several built-in senders for synchronous webhooks.
* Comes with a RedisQ-powered asynchronous webhook.
* Extendable functionality through the use of custom senders and hash functions.

Planned Features
-----------------

* Comes with many built-in senders for synchronous and asynchronous webhooks.
* Special functions for combining multiple sends of identical payloads going to one target into one.
* Follows http://resthooks.org patterns
* Great documentation
* Great tests

Usage
-----

Follow these easy steps:

1. Import the ``webhook`` decorator.
2. Define a function that returns a JSON-serializable dictionary or iterable.
3. Add the ``webhook`` decorator and pass in a ``sender_callable``.
4. Call the function!

Synchronous example (async examples to come soon):

.. code-block:: python

    from webhooks import webhook
    from webhooks.senders import targeted

    @webhook(sender_callable=targeted.sender)
    def basic(url, wife, husband):
        return {"husband": husband, "wife": wife}

    basic(url="http://httpbin.org/post", "Danny", "Audrey")

Projects Powered by Webhooks
----------------------------

* https://github.com/pydanny/dj-webhooks




History
-------

0.3.0 (2014-05-14)
++++++++++++++++++

* Added extensible Senderable class to expedite creating new senders.
* Added async_redis sender
* Added travis-ci

0.2.0 (2014-05-13)
++++++++++++++++++

* Added functioning hook decorator.
* Ramped up test coverage.
* Hash functions placed in their own module.
* Cleaned up JSON encoder thanks to Audrey Roy Greenfeld!

0.1.0 (2014-05-07)
++++++++++++++++++

* First release on PyPI.

