zulip

History

Tim Abbott 70a8e51351 Rewrite check-mirroring to be more robust and flexible. Features include: * Not forking into two processes (shells out to zwrite to send instead). This makes life easier since we're not doing concurrent programming. * Eliminated a lot of hard-to-read or unnecessary debugging output. * Adding explanatory test suggesting the likely problem for some common sets of received messages. * Much less code duplication. * Support for testing a sharded zephyr_mirror script (--sharded). * Use of the logging module to print timestamps -- makes debugging some issues a lot. * Only one sleep, and for only 10 seconds, between sending the outgoing messages and checking that they were received. * Support for running two copies of this script at the same time, so that running it manually doesn't screw up Nagios. * Passed running 100 tests run in a row. (imported from commit a3ec02ac1d1a04972e469ca30fec1790c4fb53bc)		2012-11-30 17:57:52 -05:00
..
bots	Rewrite check-mirroring to be more robust and flexible.	2012-11-30 17:57:52 -05:00
examples	send_message: Accept subject and message arguments.	2012-11-27 14:02:24 -05:00
README	api: Extend documentation a bit.	2012-11-27 12:09:56 -05:00
__init__.py	Update post-receive hook to send messages via the API.	2012-10-03 14:32:05 -04:00
common.py	call_on_each_message: Remove dead 'first' parameter.	2012-11-29 13:57:06 -05:00

README

#### Dependencies

The Humbug API Python bindings require the following Python libraries:

* simplejson
* requests (version >= 0.12)

#### Using the API

For now, the only fully supported API operation is sending a message.
The other API queries work, but are under active development, so
please make sure we know you're using them so that we can notify you
as we make any changes to them.

The easiest way to use these API bindings is to base your tools off
of the example tools under api/examples in this distribution.

If you place your API key in ~/.humbug-api-key the Python API
bindings will automatically read it in.  You can obtain your Humbug
API key from the Humbug settings page.

A typical simple bot sending API messages will look as follows:

At the top of the file:

    # Make sure the Humbug API distribution's root directory is in sys.path, then:
    import api.common
    humbug_client = api.common.HumbugAPI(email="your_email@example.com")

When you want to send a message:

    message = {
      "type": "stream",
      "to": ["support"],
      "subject": "your subject",
      "content": "your content",
    }
    humbug_client.send_message(message)

Additional examples:

    client.send_message({'type': 'stream', 'content': 'Humbug rules!',
                         'subject': 'feedback', 'to': ['support']})
    client.send_message({'type': 'private', 'content': 'Humbug rules!',
                         'to': ['user1@example.com', 'user2@example.com']})

send_message() returns a dict guaranteed to contain the following
keys: msg, result.  For successful calls, result will be "success" and
msg will be the empty string.  On error, result will be "error" and
msg will describe what went wrong.