semvec/pypi-packages huggingface dataset:
neon-nodes 0.0.2a6
Neon node clients for Hana
License: BSD-3-Clause

# Neon Nodes
Clients for connecting to a server running Hana. These are minimal classes that
are responsible for collecting a user's input, sending it to a remote system for
processing, and presenting a response to the user.

## Voice Client
The voice client will start a service that listens for a wake word on the local
system, sends recorded speech to a HANA endpoint for processing, and plays back
the response.

## Websocket Client
The websocket client starts a local listener service and establishes a websocket
connection to a remove HANA server. Compared to the Voice Client, this has 
lower latency and allows for asynchronous messages from the HANA server.

## Configuration
This service is configured via `~/.config/neon/neon.yaml`.

```yaml
neon_node:
  description: Neon Node  # Friendly description of the node
  hana_address: https://hana.neonaiservices.com  # Hana server HTTP address
  hana_username: node_user  # Hana node user username
  hana_password: node_password  # Hana node user password
```

## Running with Docker
To run Docker containers, the host system must have a Pulse server running.

### Websocket Client
```shell
docker run \
  -v ${XDG_RUNTIME_DIR}/pulse:${XDG_RUNTIME_DIR}/pulse \
  -v ~/.config/pulse/cookie:/tmp/pulse_cookie\
  -e PULSE_COOKIE=/tmp/pulse_cookie \
  -e PULSE_SERVER=unix:${XDG_RUNTIME_DIR}/pulse/native \
  --device /dev/snd \
  neon-node-websocket
```