Skip to main content

Generic event bus for inter process asyncio communication

Project description

Documentation Status

Documentation hosted by ReadTheDocs

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

  • Push boundaries (don’t push this into process x)

  • Testing

Developer Setup

If you would like to hack on lahja, please check out the Ethereum Development 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:

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:

# 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:

# 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:

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:

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lahja-0.13.0.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

lahja-0.13.0-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file lahja-0.13.0.tar.gz.

File metadata

  • Download URL: lahja-0.13.0.tar.gz
  • Upload date:
  • Size: 20.1 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.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for lahja-0.13.0.tar.gz
Algorithm Hash digest
SHA256 3ed0d24c9509dfd53f7f2e4e78af303a2376a7739bf999bc1503e9fbfba3e17c
MD5 b1e2dcab16b01dd27dfd3d419bbc2c16
BLAKE2b-256 af420e03ccf6cc2e6a89a449d21a1877e42647d03bbf35f6ed5273d46cee9598

See more details on using hashes here.

File details

Details for the file lahja-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: lahja-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 25.8 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.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for lahja-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e39baa9260f5b97d56784a163826a77cbab154e38ac52b2b356bd644aca03af
MD5 ec7025a2cd24eecce47de58d5ac9c009
BLAKE2b-256 5d393d4993c074bc27ace9755ed171182c8a24323e6fbc805966e8736f1aeb90

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page