Metadata-Version: 2.1
Name: neon-messagebus
Version: 0.0.2a2
Summary: Neon Messagebus Module
Home-page: https://github.com/NeonGeckoCom/neon_messagebus
Author: Neongecko
Author-email: developers@neon.ai
License: BSD-3-Clause
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: mycroft-messagebus-client (!=0.9.2,!=0.9.3,~=0.9)
Requires-Dist: neon-utils (>=0.13.2a1,~=0.13)
Requires-Dist: ovos-core[bus] (~=0.0.1)

# Neon Messagebus
Messagebus Module for Neon Core. This module can be treated as a replacement for the
[mycroft-core](https://github.com/MycroftAI/mycroft-core) bus module. This module handles communication between other 
connected modules.

## Neon Enhancements
`neon-messagebus` extends `mycroft.messagebus` with the following added functionality:
* Utilities for sending files and other data over the bus
* A service for managing "signals" used for IPC

## Compatibility
This package can be treated as a drop-in replacement for `mycroft.messagebus`

## Running in Docker
The included `Dockerfile` may be used to build a docker container for the neon_messagebus module. The below command may be used
to start the container.

```shell
docker run -d \
--network=host \
--name=neon_messagebus \
-v ${NEON_DATA_DIR}:/home/neon/.local/share/neon:rw \
-v ${NEON_CONFIG_DIR}:/home/neon/.config/neon:rw \
neon_messagebus
```

>*Note:* The above example assumes Docker data locations are specified in the `NEON_DATA_DIR` and `NEON_CONFIG_DIR`
> environment variables.


