Skip to main content

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

  • 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](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


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.14.0.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

lahja-0.14.0-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lahja-0.14.0.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for lahja-0.14.0.tar.gz
Algorithm Hash digest
SHA256 0a43e193e4bb64e985f6225a6081c41d166c58b2caa5f9cf3953947d55e052fd
MD5 99c629f77ecf0cfe54c5077e1bf361db
BLAKE2b-256 c69d4c849bbd6735bfdcb5e02aa666b3885e42fe89b17ff1f1f8fe9f69efa951

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lahja-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 24.5 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/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for lahja-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5844873fe7969771b6f7f7af9933626faa1c8f49f12078a3d162dfc924c3f93
MD5 cc1a04ea58bcf74de03af951adb5df6c
BLAKE2b-256 b96f51c2877057bf4648462c1211feff77c574e9997c53f00a461122025b583f

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