https://github.com/baroquehq/baroque
Baroque is an event brokering framework with a honey-sweet interface
https://github.com/baroquehq/baroque
baroque broker event-driven eventbus events eventstore framework honey-sweet-interface humans python-3
Last synced: 12 months ago
JSON representation
Baroque is an event brokering framework with a honey-sweet interface
- Host: GitHub
- URL: https://github.com/baroquehq/baroque
- Owner: baroquehq
- License: mit
- Created: 2017-03-30T12:42:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-24T11:58:17.000Z (almost 3 years ago)
- Last Synced: 2025-03-23T19:51:33.580Z (about 1 year ago)
- Topics: baroque, broker, event-driven, eventbus, events, eventstore, framework, honey-sweet-interface, humans, python-3
- Language: Python
- Homepage: http://baroque.readthedocs.io
- Size: 89.8 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Baroque
## Events made easy
Baroque is an event brokering framework with a honey-sweet interface.
It features an out-of-the-box efficient implementation of the publish-subscriber
pattern enabled by high-level abstractions, allowing quick development of
event-driven applications.
The main focus of Baroque is provide a human-friendly interface to event
brokering operations, in terms of API and configuration.
### Features in a nutshell
- Create **events** as lightweight JSON containers of custom metadata, each
with a named type and suitable of JSON schema validation
- **publish** events of any type and **subscribe** execution of stateless
callback functions (aka: **reactors**) upon events firing
- reactors can be conditionally executed (you say when the magic happens). You
can either provide your custom reactors or leverage Baroque's built-in ones
- validate
- create event distribution **topics** from specified pools of event types
and easily publish events on them, triggering execution of subscribers'
reactors
- optionally track events in-memory or save them to persistent datastores
Baroque is...
- designed for humans (nerds and non-nerds!)
- plug and play into your own code
- easily configurable: go with reasonable defaults or edit a simple
YML config file
- extensible through a set of extension code hooks
- heavily tested
## Installation
Baroque runs on Python 3.5+
Install the latest stable version with `pip`:
```shell
$ pip install baroque
```
As Baroque is currently under heavy development, its API may change without
notice: fetch the latest modifications on the development branch with:
```shell
$ pip install git+https://github.com/baroquehq/baroque.git@dev
```
## Getting started
```python
from baroque import Baroque, Reactor, EventFactory
# Pub-sub is easy with Baroque!
# 1. Instantiate the event broker:
brq = Baroque()
# 2. Create reactors, which basically are functions. This one - in example -
# prints the input event's content to the console as JSON
reactor = Reactor(lambda event: print(event.json()))
# 3. Now tell the broker that we want to run our reactor upon events of any type:
brq.on_any_event_run(reactor)
# 4. Good! Now let's publish an event on the broker:
event = EventFactory.new(payload=dict(key1='value1', key2='value2'), owner='me')
brq.publish(event)
# ... and our terminal should display something like this:
'''
{
"timestamp": "2017-03-28T23:20:57Z",
"owner": "me",
"links": [],
"tags": [],
"payload": {
"key2": "value2",
"key1": "value1"},
"status": "unpublished",
...
}
'''
```
## Documentation
- A [guided tour through Baroque features](http://baroque.readthedocs.io/en/latest/usage.html)
- A few [usage scenarios](http://baroque.readthedocs.io/en/latest/examples.html)
- Baroque's [software API documentation](http://baroque.readthedocs.io/en/latest/baroque.html)
## License
MIT license