Skip to content

Latest commit

 

History

History
99 lines (66 loc) · 2.75 KB

README.md

File metadata and controls

99 lines (66 loc) · 2.75 KB
Raw

Care Livekit

Release Status Build Status

Care Livekit is a plugin for care to add voice auto fill support using external services like OpenAI whisper and Google Speech to Text.

Features

  • Voice auto fill support for care
  • Support for OpenAI whisper and Google Speech to Text

Installation

https://care-be-docs.ohc.network/pluggable-apps/configuration.html

https://github.com/ohcnetwork/care/blob/develop/plug_config.py

To install care livekit, you can add the plugin config in care/plug_config.py as follows:

...

livekit_plug = Plug(
    name="livekit",
    package_name="git+https://github.com/ohcnetwork/care_livekit.git",
    version="@main",
    configs={},
)
plugs = [livekit_plug]
...

Local Development

To develop the plug in local environment along with care, follow the steps below:

  1. Go to the care root directory and clone the plugin repository:
cd care
git clone [email protected]:ohcnetwork/care_livekit.git
  1. Add the plugin config in plug_config.py
...

livekit_plugin = Plug(
    name="livekit", # name of the django app in the plugin
    package_name="/app/care_livekit", # this has to be /app/ + plugin folder name
    version="", # keep it empty for local development
    configs={}, # plugin configurations if any
)
plugs = [livekit_plug]

...
  1. Tweak the code in plugs/manager.py, install the plugin in editable mode
...

subprocess.check_call(
    [sys.executable, "-m", "pip", "install", "-e", *packages] # add -e flag to install in editable mode
)

...
  1. Rebuild the docker image and run the server
make re-build
make up

[!IMPORTANT]: Do not push these changes in a PR. These changes are only for local development.

Configuration

The following configurations variables are available for Care Livekit:

  • LIVEKIT_API_URL: Websocket URL for the Livekit server, default is wss://livekit.ohc.network
  • LIVEKIT_API_KEY: API key for the Livekit server
  • LIVEKIT_API_SECRET: API secret for the Livekit server
  • LIVEKIT_ROOM_NAME_PREFIX: Prefix for the room name, default is care-

The plugin will try to find the API key from the config first and then from the environment variable.

License

This project is licensed under the terms of the MIT license.

This plugin was created with Cookiecutter using the ohcnetwork/care-plugin-cookiecutter.