Metadata-Version: 2.1
Name: rhasspy-microphone-cli-hermes
Version: 0.1.2
Summary: UNKNOWN
Home-page: https://github.com/rhasspy/rhasspy-microphone-cli-hermes
Author: Michael Hansen
Author-email: hansen.mike@gmail.com
License: UNKNOWN
Description: # Rhasspy Microphone Hermes MQTT Service
        
        [![Continous Integration](https://github.com/rhasspy/rhasspy-microphone-cli-hermes/workflows/Tests/badge.svg)](https://github.com/rhasspy/rhasspy-microphone-cli-hermes/actions)
        [![GitHub license](https://img.shields.io/github/license/rhasspy/rhasspy-microphone-cli-hermes.svg)](https://github.com/rhasspy/rhasspy-microphone-cli-hermes/blob/master/LICENSE)
        
        Records audio from an external program and publishes WAV chunks according to the [Hermes protocol](https://docs.snips.ai/reference/hermes).
        
        ## Running With Docker
        
        ```bash
        docker run -it rhasspy/rhasspy-microphone-cli-hermes:<VERSION> <ARGS>
        ```
        
        ## Building From Source
        
        Clone the repository and create the virtual environment:
        
        ```bash
        git clone https://github.com/rhasspy/rhasspy-microphone-cli-hermes.git
        cd rhasspy-microphone-cli-hermes
        make venv
        ```
        
        Run the `bin/rhasspy-microphone-cli-hermes` script to access the command-line interface:
        
        ```bash
        bin/rhasspy-microphone-cli-hermes --help
        ```
        
        ## Building the Debian Package
        
        Follow the instructions to build from source, then run:
        
        ```bash
        source .venv/bin/activate
        make debian
        ```
        
        If successful, you'll find a `.deb` file in the `dist` directory that can be installed with `apt`.
        
        ## Building the Docker Image
        
        Follow the instructions to build from source, then run:
        
        ```bash
        source .venv/bin/activate
        make docker
        ```
        
        This will create a Docker image tagged `rhasspy/rhasspy-microphone-cli-hermes:<VERSION>` where `VERSION` comes from the file of the same name in the source root directory.
        
        NOTE: If you add things to the Docker image, make sure to whitelist them in `.dockerignore`.
        
        ## Command-Line Options
        
        ```
        usage: rhasspy-microphone-cli-hermes [-h] --record-command RECORD_COMMAND
                                             --sample-rate SAMPLE_RATE --sample-width
                                             SAMPLE_WIDTH --channels CHANNELS
                                             [--host HOST] [--port PORT]
                                             [--siteId SITEID] [--debug]
        
        optional arguments:
          -h, --help            show this help message and exit
          --record-command RECORD_COMMAND
                                Command to record raw audio data
          --sample-rate SAMPLE_RATE
                                Sample rate of recorded audio in hertz (e.g., 16000)
          --sample-width SAMPLE_WIDTH
                                Sample width of recorded audio in bytes (e.g., 2)
          --channels CHANNELS   Number of channels in recorded audio (e.g., 1)
          --host HOST           MQTT host (default: localhost)
          --port PORT           MQTT port (default: 1883)
          --siteId SITEID       Hermes siteId of this server
          --debug               Print DEBUG messages to the console
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
