You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-21Lines changed: 12 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -8,20 +8,20 @@ This package lets you trigger events to your client and query the state of your
8
8
9
9
In order to use this library, you need to have a free account on <http://pusher.com>. After registering, you will need the application credentials for your app.
10
10
11
-
Features
12
-
--------
11
+
## Features
13
12
14
13
* Python 2.6, 2.7 and 3.3 support
15
14
* Adapters for various http libraries like requests, urlfetch, aiohttp and tornado.
-[Getting Information For All Channels](#getting-information-for-all-channels)
27
27
-[Getting Information For A Specific Channel](#getting-information-for-a-specific-channel)
@@ -34,8 +34,7 @@ Features
34
34
-[Running the tests](#running-the-tests)
35
35
-[License](#license)
36
36
37
-
Installation
38
-
------------
37
+
## Installation
39
38
40
39
You can install this module using your package management method or choice,
41
40
normally `easy_install` or `pip`. For example:
@@ -46,8 +45,7 @@ pip install pusher
46
45
47
46
Users on Python 2.x and older versions of pip may get a warning, due to pip compiling the optional `pusher.aiohttp` module, which uses Python 3 syntax. However, as `pusher.aiohttp` is not used by default, this does not affect the library's functionality. See [our Github issue](https://github.com/pusher/pusher-http-python/issues/52), as well as [this issue from Gunicorn](https://github.com/benoitc/gunicorn/issues/788) for more details.
48
47
49
-
Getting started
50
-
---------------
48
+
## Getting started
51
49
52
50
The minimum configuration required to use the Pusher object are the three
53
51
constructor arguments which identify your Pusher app. You can find them by
To trigger an event on one or more channels, use the `trigger` method on the `Pusher` object.
99
96
@@ -211,8 +208,7 @@ data = {
211
208
212
209
**NOTE:** This is currently a BETA feature and there might be minor bugs and issues. Changes to the API will be kept to a minimum, but changes are expected. If you come across any bugs or issues, please do get in touch via [support](support@pusher.com) or create an issue here.
If you have webhooks set up to POST a payload to a specified endpoint, you may wish to validate that these are actually from Pusher. The `Pusher` object achieves this by checking the authentication signature in the request body using your application credentials.
336
330
@@ -408,13 +402,11 @@ Limit to 10 channels per trigger | ✔
408
402
Limit event name length to 200 chars | ✔
409
403
410
404
411
-
Running the tests
412
-
-----------------
405
+
## Running the tests
413
406
414
407
To run the tests run `python setup.py test`
415
408
416
-
Making a release
417
-
----------------
409
+
## Making a release
418
410
419
411
* Update the CHANGELOG.md file. `git changelog` from the
420
412
[git-extras](https://github.com/tj/git-extras/blob/master/Commands.md#git-changelog) package can be useful to pull commits from the release.
@@ -426,7 +418,6 @@ Making a release
426
418
If you get the `error: invalid command 'bdist_wheel'` message on the last step
427
419
`pip install wheel` and re-run `make`.
428
420
429
-
License
430
-
-------
421
+
## License
431
422
432
423
Copyright (c) 2015 Pusher Ltd. See LICENSE for details.
0 commit comments