Extremely Ease Event Emitter (eeee)¶

Extremely Easy Event Emitter¶

Info:	Extremely Easy Event Emitter.
Author:	Paweł Zadrożny @pawelzny <pawel.zny@gmail.com>

Features¶

Asynchronous Event emitter based on asyncio
Subscribe any callable handler
Filter events by Publisher
Easy enable-disable events on runtime
Subscribe handlers using decorator

Installation¶

pip install eeee

Package: https://pypi.org/project/eeee/

Quick Example¶

from eeee import Event, Publisher

my_event = Event('MyEvent')

# Subscribe takes publisher instance or name as optional argument.
# If publisher is defined handler will be triggered only when that
# particular publisher send a message.
# Leave empty to listen to all publishers within this event.
@my_event.subscribe()
async def custom_handler(message, publisher, event):
    print(message, publisher, event)

result = await my_event.publish('New message arrived!', Publisher('global'))

Public API¶

Publish/Subscribe
Exceptions
Utilities
- Subscribe decorator
- Asyncio context manager

Utilities ¶

Asyncio context manager ¶

Provided by Context Loop can be imported from eeee as well. Context loop allow to execute asynchronous code ad-hoc.

import eeee import Loop

>>> my_event = Event('MyEvent')
>>> with Loop(my_event.publish({'message': 'secret'})) as loop:
...   result = loop.run_until_complete()
...

Credits¶

Development¶

Paweł Zadrożny @pawelzny <pawel.zny@gmail.com>

Contributors¶

None yet. Why not be the first?

Read more how to contribute on Contributing.

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/pawelzny/eeee/issues

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

authentication could always use more documentation, whether as part of the official authentication docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/pawelzny/eeee/issues

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up eeee for local development.

Fork the eeee repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/eeee.git

3. Install your local copy into a virtualenv. Assuming you have PipEnv installed, this is how you set up your fork for local development:

$ cd eeee/
$ make install-dev

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ make test-all
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 3.4, 3.5, and 3.6, and for PyPy3. Check https://circleci.com/gh/pawelzny/eeee and make sure that the tests pass for all supported Python versions.

LICENSE¶

ISC License

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.