summaryrefslogtreecommitdiff
path: root/docs/source/index.rst
blob: 8a594bc5b20e35cfc02f0c7a42f121a1fad720cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Blinker Documentation
=====================

Blinker provides fast & simple object-to-object and broadcast
signaling for Python objects.

The core of Blinker is quite small but provides powerful features:

 - a global registry of named signals
 - anonymous signals
 - custom name registries
 - permanently or temporarily connected receivers
 - automatically disconnected receivers via weak referencing
 - sending arbitrary data payloads
 - collecting return values from signal receivers


Requirements
------------

Python 2.4 or later.  No other modules are required.

As of Blinker 0.8, Python 3.1 passes all tests except for weakly
binding to instance methods.


License
-------

Blinker is provided under the MIT License.


Contents
--------

.. toctree::
   :maxdepth: 2

   signals
   api