• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1pyee
2====
3
4pyee is a rough port of
5`node.js's EventEmitter <https://nodejs.org/api/events.html>`_. Unlike its
6namesake, it includes a number of subclasses useful for implementing async
7and threaded programming in python, such as async/await as seen in python 3.5+.
8
9Install:
10--------
11
12You can install this project into your environment of choice using ``pip``::
13
14    pip install pyee
15
16API Docs:
17---------
18
19.. toctree::
20   :maxdepth: 2
21
22.. automodule:: pyee
23
24.. autoclass:: pyee.EventEmitter
25    :members:
26
27.. autoclass:: pyee.asyncio.AsyncIOEventEmitter
28    :members:
29
30.. autoclass:: pyee.twisted.TwistedEventEmitter
31    :members:
32
33.. autoclass:: pyee.executor.ExecutorEventEmitter
34    :members:
35
36.. autoclass:: pyee.trio.TrioEventEmitter
37    :members:
38
39.. autoclass:: BaseEventEmitter
40    :members:
41
42.. autoexception:: pyee.PyeeException
43
44.. autofunction:: pyee.uplift.uplift
45
46.. autofunction:: pyee.cls.on
47
48.. autofunction:: pyee.cls.evented
49
50
51Some Links
52==========
53
54* `Fork Me On GitHub! <https://github.com/jfhbrook/pyee>`_
55* `These Very Docs on readthedocs.io <https://pyee.rtfd.io>`_
56* :ref:`genindex`
57* :ref:`modindex`
58* :ref:`search`
59
60Changelog
61=========
62
63.. include:: ../CHANGELOG.rst
64