semvec/pypi-packages huggingface dataset:
chatterbox-bus-client 0.0.11
Chatterbox Messagebus Client
License: Apache-2.0


# Chatterbox Bus Client

This module is a simple interface for the chatterbox messagebus and can be 
used to connect to chatterbox, send messages and react to messages sent by the 
Chatterbox system.


## MessageBusClient()

The `MessageBusClient()` If no arguments are provided it will try to connect to a local instance of chatterbox core on the default endpoint and port.


## Message()

The `Message` object is a representation of the messagebus message, this will always contain a message type but can also contain data and context. 
Data is usually real information while the context typically contain information on where the message originated or who the intended recipient is.

```python
Message('MESSAGE_TYPE', data={'meaning': 42}, context={'origin': 'A.Dent'})
```

AES encryption is supported by setting a key in `/etc/chatterbox/bus.conf`

## Examples

Below are some a couple of simple cases for sending a message on the bus as well
as reacting to messages on the bus

### Sending a message on the bus.

```python
from chatterbox_bus_client import MessageBusClient, Message

print('Setting up client to connect to a local chatterbox instance')
client = MessageBusClient()
client.run_in_thread()

print('Sending speak message...')
client.emit(Message('speak', data={'utterance': 'Hello World'}))
```

### Catching a message on the messagebus

```python
from chatterbox_bus_client import MessageBusClient, Message

print('Setting up client to connect to a local chatterbox instance')
client = MessageBusClient()


def print_utterance(message):
    print('Mycroft said "{}"'.format(message.data.get('utterance')))


print('Registering handler for speak message...')
client.on('speak', print_utterance)

client.run_forever()
```