Generic event bus for inter process asyncio communication
Project description
# Lahja
[![Documentation Status](https://readthedocs.org/projects/lahja/badge/?version=latest)](http://lahja.readthedocs.io/en/latest/?badge=latest)
[Documentation hosted by ReadTheDocs](http://lahja.readthedocs.io/en/latest/)
DISCLAIMER: This is alpha state software. Expect bugs.
Lahja is a generic multi process event bus implementation written in Python 3.6+ to enable lightweight inter-process communication, based on non-blocking asyncio.
## What is this for?
Lahja is tailored around one primary use case: enabling multi process Python applications to communicate through events between processes in a non-blocking asyncio fashion.
Key facts:
non-blocking APIs based on asyncio
lightweight and simple (e.g no IPC pipes etc)
easy multicasting of events (one event, many independent receivers)
easy event routing (e.g route event X only to process group Y)
multiple consuming APIs to adapt to different use cases and styles
## TODOs
Filter support (e.g. only subscribe to EventX from origin y)
Push boundaries (don’t push this into process x)
Testing
Performance analysis
## Developer Setup
If you would like to hack on lahja, please check out the [Ethereum Development Tactical Manual](https://github.com/pipermerriam/ethereum-dev-tactical-manual) for information on how we do:
Testing
Pull Requests
Code Style
Documentation
### Development Environment Setup
You can set up your dev environment with:
`sh git clone https://github.com/cburgdorf/lahja cd lahja virtualenv -p python3 venv . venv/bin/activate pip install -e .[dev] `
### Testing Setup
During development, you might like to have tests run on every file save.
Show flake8 errors on file change:
`sh # Test flake8 when-changed -v -s -r -1 lahja/ tests/ -c "clear; flake8 lahja tests && echo 'flake8 success' || echo 'error'" `
Run multi-process tests in one command, but without color:
`sh # in the project root: pytest --numprocesses=4 --looponfail --maxfail=1 # the same thing, succinctly: pytest -n 4 -f --maxfail=1 `
Run in one thread, with color and desktop notifications:
`sh cd venv ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on lahja failed'" ../tests ../lahja `
### Release setup
For Debian-like systems: ` apt install pandoc `
To release a new version:
`sh make release bump=$$VERSION_PART_TO_BUMP$$ `
#### How to bumpversion
The version format for this repo is {major}.{minor}.{patch} for stable, and {major}.{minor}.{patch}-{stage}.{devnum} for unstable (stage can be alpha or beta).
To issue the next version in line, specify which part to bump, like make release bump=minor or make release bump=devnum.
If you are in a beta version, make release bump=stage will switch to a stable.
To issue an unstable version when the current version is stable, specify the new version explicitly, like make release bump=”–new-version 4.0.0-alpha.1 devnum”
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file lahja-0.12.0.tar.gz
.
File metadata
- Download URL: lahja-0.12.0.tar.gz
- Upload date:
- Size: 12.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8b1482a49076b2197740f4844ebd6a2dd74d919b2ae1f2581fc5c39d8588702 |
|
MD5 | 700ef02e554db106855dd58cee22f22c |
|
BLAKE2b-256 | a56b7dc3427883c03ae1e731f4470de13c0bf6c4e392f31b5543ca4bad1d30d1 |
File details
Details for the file lahja-0.12.0-py3-none-any.whl
.
File metadata
- Download URL: lahja-0.12.0-py3-none-any.whl
- Upload date:
- Size: 16.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 335648d304ceb6268395087b8e7db0796845e2b417d25a58c0437c74b9d44995 |
|
MD5 | 141d537b8bf3551f71a8017f90b8337d |
|
BLAKE2b-256 | da91f0e9a5fe64b2abb96c1f08392441802c84840b10010c455a81e752f220e1 |