ovos-solver-hivemind-plugin 0.0.1__tar.gz

ovos-solver-hivemind-plugin-0.0.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: ovos-solver-hivemind-plugin
+Version: 0.0.1
+Summary: A question solver plugin for OVOS
+Home-page: https://github.com/JarbasHiveMind/ovos-solver-hivemind-plugin
+Author: jarbasai
+Author-email: jarbasai@mailfence.com
+License: MIT
+Keywords: OVOS openvoiceos plugin utterance fallback query
+Description-Content-Type: text/markdown
+
+# HiveMind solver
+
+exposes a hivemind connection as a solver plugin
+
+use cases:
+- allow your apps to get responses from a remote HiveMind
+- expose HiveMind to any OpenAI compatible UI, via [ovos-persona-server](https://github.com/OpenVoiceOS/ovos-persona-server)
+- Integrate HiveMind/OVOS into a [MOS (Mixture Of Solvers)](https://github.com/TigreGotico/ovos-MoS)
+
+## Install
+
+`pip install ovos-solver-hivemind-plugin`
+
+## Setup
+
+You need to register the solver in the HiveMind server
+```bash
+$ hivemind-core add-client
+Credentials added to database!
+
+Node ID: 2
+Friendly Name: HiveMind-Node-2
+Access Key: 5a9e580a2773a262cbb23fe9759881ff
+Password: 9b247ca66c7cd2b6388ad49ca504279d
+Encryption Key: 4185240103de0770
+WARNING: Encryption Key is deprecated, only use if your client does not support password
+```
+
+And then set the identity file in the satellite device (where the solver will run)
+```bash
+$ hivemind-client set-identity --key 5a9e580a2773a262cbb23fe9759881ff --password 9b247ca66c7cd2b6388ad49ca504279d --host 0.0.0.0 --port 5678 --siteid test
+identity saved: /home/miro/.config/hivemind/_identity.json
+```
+
+check the created identity file if you like
+```bash
+$ cat ~/.config/hivemind/_identity.json
+{
+    "password": "9b247ca66c7cd2b6388ad49ca504279d",
+    "access_key": "5a9e580a2773a262cbb23fe9759881ff",
+    "site_id": "test",
+    "default_port": 5678,
+    "default_master": "ws://0.0.0.0"
+}
+```
+
+test that a connection is possible using the identity file
+```bash
+$ hivemind-client test-identity
+(...)
+2024-05-20 21:22:28.003 - OVOS - hivemind_bus_client.client:__init__:112 - INFO - Session ID: 34d75c93-4e65-4ea9-b5f4-87169dcfda01
+(...)
+== Identity successfully connected to HiveMind!
+```
+
+## Usage
+
+For usage with any solver framework, such as persona, use `"ovos-solver-hivemind-plugin"` for the solver id
+
+Standalone usage
+
+```python
+from ovos_hivemind_solver import HiveMindSolver
+
+bot = HiveMindSolver()
+bot.connect()  # connection info from identity file
+print(bot.spoken_answer("what is the speed of light?"))
+```
+
+## Credits
+
+![image](https://github.com/user-attachments/assets/809588a2-32a2-406c-98c0-f88bf7753cb4)
+
+> This work was sponsored by VisioLab, part of [Royal Dutch Visio](https://visio.org/), is the test, education, and research center in the field of (innovative) assistive technology for blind and visually impaired people and professionals. We explore (new) technological developments such as Voice, VR and AI and make the knowledge and expertise we gain available to everyone.

ovos-solver-hivemind-plugin-0.0.1/README.md

@@ -0,0 +1,74 @@
+# HiveMind solver
+
+exposes a hivemind connection as a solver plugin
+
+use cases:
+- allow your apps to get responses from a remote HiveMind
+- expose HiveMind to any OpenAI compatible UI, via [ovos-persona-server](https://github.com/OpenVoiceOS/ovos-persona-server)
+- Integrate HiveMind/OVOS into a [MOS (Mixture Of Solvers)](https://github.com/TigreGotico/ovos-MoS)
+
+## Install
+
+`pip install ovos-solver-hivemind-plugin`
+
+## Setup
+
+You need to register the solver in the HiveMind server
+```bash
+$ hivemind-core add-client
+Credentials added to database!
+
+Node ID: 2
+Friendly Name: HiveMind-Node-2
+Access Key: 5a9e580a2773a262cbb23fe9759881ff
+Password: 9b247ca66c7cd2b6388ad49ca504279d
+Encryption Key: 4185240103de0770
+WARNING: Encryption Key is deprecated, only use if your client does not support password
+```
+
+And then set the identity file in the satellite device (where the solver will run)
+```bash
+$ hivemind-client set-identity --key 5a9e580a2773a262cbb23fe9759881ff --password 9b247ca66c7cd2b6388ad49ca504279d --host 0.0.0.0 --port 5678 --siteid test
+identity saved: /home/miro/.config/hivemind/_identity.json
+```
+
+check the created identity file if you like
+```bash
+$ cat ~/.config/hivemind/_identity.json
+{
+    "password": "9b247ca66c7cd2b6388ad49ca504279d",
+    "access_key": "5a9e580a2773a262cbb23fe9759881ff",
+    "site_id": "test",
+    "default_port": 5678,
+    "default_master": "ws://0.0.0.0"
+}
+```
+
+test that a connection is possible using the identity file
+```bash
+$ hivemind-client test-identity
+(...)
+2024-05-20 21:22:28.003 - OVOS - hivemind_bus_client.client:__init__:112 - INFO - Session ID: 34d75c93-4e65-4ea9-b5f4-87169dcfda01
+(...)
+== Identity successfully connected to HiveMind!
+```
+
+## Usage
+
+For usage with any solver framework, such as persona, use `"ovos-solver-hivemind-plugin"` for the solver id
+
+Standalone usage
+
+```python
+from ovos_hivemind_solver import HiveMindSolver
+
+bot = HiveMindSolver()
+bot.connect()  # connection info from identity file
+print(bot.spoken_answer("what is the speed of light?"))
+```
+
+## Credits
+
+![image](https://github.com/user-attachments/assets/809588a2-32a2-406c-98c0-f88bf7753cb4)
+
+> This work was sponsored by VisioLab, part of [Royal Dutch Visio](https://visio.org/), is the test, education, and research center in the field of (innovative) assistive technology for blind and visually impaired people and professionals. We explore (new) technological developments such as Voice, VR and AI and make the knowledge and expertise we gain available to everyone.

ovos-solver-hivemind-plugin-0.0.1/ovos_hivemind_solver/__init__.py

@@ -0,0 +1,68 @@
+from hivemind_bus_client import HiveMessageBusClient
+from ovos_bus_client.message import Message
+from ovos_plugin_manager.templates.solvers import QuestionSolver
+from ovos_utils.log import LOG
+from threading import Event
+
+
+class HiveMindSolver(QuestionSolver):
+    def __init__(self, config=None):
+        config = config or {}
+        super().__init__(config, enable_tx=False, priority = 70)
+        self.hm = None
+        self._response = Event()
+        self._responses = []
+        if self.config.get("autoconnect"):
+            self.connect()
+
+    def bind(self, hm: HiveMessageBusClient):
+        """if you want to re-use a open connection"""
+        self.hm = hm
+
+    def connect(self):
+        """assume identity set beforehand, eg via `hivemind-client set-identity`
+        """
+        self.hm = HiveMessageBusClient(useragent="ovos-hivemind-solver")
+        self.hm.connect()
+        self.hm.on_mycroft("speak", self._receive_answer)
+        self.hm.on_mycroft("ovos.utterance.handled", self._end_of_response)
+
+    def _end_of_response(self, message):
+        self._response.set()
+
+    def _receive_answer(self, message):
+        utt = message.data["utterance"]
+        self._responses.append(utt)
+
+    # abstract Solver methods
+    def get_data(self, query, context=None):
+        return {"answer": self.get_spoken_answer(query, context)}
+
+    def get_spoken_answer(self, query, context=None, timeout=10):
+        if self.hm is None:
+            LOG.error("not connected to HiveMind")
+            return
+        self._response.clear()
+        self._responses = []
+
+        context = context or {}
+        if "session" in context:
+            lang = context["session"]["lang"]
+        else:
+            lang = context.get("lang") or self.config.get("lang", "en-us")
+        mycroft_msg = Message("recognizer_loop:utterance",
+                              {"utterances": [query], "lang": lang})
+        self.hm.emit_mycroft(mycroft_msg)
+        self._response.wait(timeout=timeout)
+        if self._responses:
+            # merge multiple speak messages into one
+            return "\n".join(self._responses)
+        return None  # let next solver attempt
+
+
+if __name__ == "__main__":
+    cfg = {
+        "autoconnect": True
+    }
+    bot = HiveMindSolver(config=cfg)
+    print(bot.spoken_answer("what is the speed of light?"))

ovos-solver-hivemind-plugin-0.0.1/ovos_hivemind_solver/version.py

@@ -0,0 +1,7 @@
+# The following lines are replaced during the release process.
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 1
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK

ovos-solver-hivemind-plugin-0.0.1/ovos_solver_hivemind_plugin.egg-info/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: ovos-solver-hivemind-plugin
+Version: 0.0.1
+Summary: A question solver plugin for OVOS
+Home-page: https://github.com/JarbasHiveMind/ovos-solver-hivemind-plugin
+Author: jarbasai
+Author-email: jarbasai@mailfence.com
+License: MIT
+Keywords: OVOS openvoiceos plugin utterance fallback query
+Description-Content-Type: text/markdown
+
+# HiveMind solver
+
+exposes a hivemind connection as a solver plugin
+
+use cases:
+- allow your apps to get responses from a remote HiveMind
+- expose HiveMind to any OpenAI compatible UI, via [ovos-persona-server](https://github.com/OpenVoiceOS/ovos-persona-server)
+- Integrate HiveMind/OVOS into a [MOS (Mixture Of Solvers)](https://github.com/TigreGotico/ovos-MoS)
+
+## Install
+
+`pip install ovos-solver-hivemind-plugin`
+
+## Setup
+
+You need to register the solver in the HiveMind server
+```bash
+$ hivemind-core add-client
+Credentials added to database!
+
+Node ID: 2
+Friendly Name: HiveMind-Node-2
+Access Key: 5a9e580a2773a262cbb23fe9759881ff
+Password: 9b247ca66c7cd2b6388ad49ca504279d
+Encryption Key: 4185240103de0770
+WARNING: Encryption Key is deprecated, only use if your client does not support password
+```
+
+And then set the identity file in the satellite device (where the solver will run)
+```bash
+$ hivemind-client set-identity --key 5a9e580a2773a262cbb23fe9759881ff --password 9b247ca66c7cd2b6388ad49ca504279d --host 0.0.0.0 --port 5678 --siteid test
+identity saved: /home/miro/.config/hivemind/_identity.json
+```
+
+check the created identity file if you like
+```bash
+$ cat ~/.config/hivemind/_identity.json
+{
+    "password": "9b247ca66c7cd2b6388ad49ca504279d",
+    "access_key": "5a9e580a2773a262cbb23fe9759881ff",
+    "site_id": "test",
+    "default_port": 5678,
+    "default_master": "ws://0.0.0.0"
+}
+```
+
+test that a connection is possible using the identity file
+```bash
+$ hivemind-client test-identity
+(...)
+2024-05-20 21:22:28.003 - OVOS - hivemind_bus_client.client:__init__:112 - INFO - Session ID: 34d75c93-4e65-4ea9-b5f4-87169dcfda01
+(...)
+== Identity successfully connected to HiveMind!
+```
+
+## Usage
+
+For usage with any solver framework, such as persona, use `"ovos-solver-hivemind-plugin"` for the solver id
+
+Standalone usage
+
+```python
+from ovos_hivemind_solver import HiveMindSolver
+
+bot = HiveMindSolver()
+bot.connect()  # connection info from identity file
+print(bot.spoken_answer("what is the speed of light?"))
+```
+
+## Credits
+
+![image](https://github.com/user-attachments/assets/809588a2-32a2-406c-98c0-f88bf7753cb4)
+
+> This work was sponsored by VisioLab, part of [Royal Dutch Visio](https://visio.org/), is the test, education, and research center in the field of (innovative) assistive technology for blind and visually impaired people and professionals. We explore (new) technological developments such as Voice, VR and AI and make the knowledge and expertise we gain available to everyone.

ovos-solver-hivemind-plugin-0.0.1/ovos_solver_hivemind_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+setup.py
+ovos_hivemind_solver/__init__.py
+ovos_hivemind_solver/version.py
+ovos_solver_hivemind_plugin.egg-info/PKG-INFO
+ovos_solver_hivemind_plugin.egg-info/SOURCES.txt
+ovos_solver_hivemind_plugin.egg-info/dependency_links.txt
+ovos_solver_hivemind_plugin.egg-info/entry_points.txt
+ovos_solver_hivemind_plugin.egg-info/requires.txt
+ovos_solver_hivemind_plugin.egg-info/top_level.txt
+ovos_solver_hivemind_plugin.egg-info/zip-safe

ovos-solver-hivemind-plugin-0.0.1/ovos_solver_hivemind_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ovos-solver-hivemind-plugin-0.0.1/ovos_solver_hivemind_plugin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[neon.plugin.solver]
+ovos-solver-hivemind-plugin = ovos_hivemind_solver:HiveMindSolver

ovos-solver-hivemind-plugin-0.0.1/ovos_solver_hivemind_plugin.egg-info/requires.txt

@@ -0,0 +1,3 @@
+ovos-plugin-manager
+ovos-translate-server-plugin
+hivemind_bus_client>=0.0.4a21

ovos-solver-hivemind-plugin-0.0.1/ovos_solver_hivemind_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+ovos_hivemind_solver

ovos-solver-hivemind-plugin-0.0.1/ovos_solver_hivemind_plugin.egg-info/zip-safe

@@ -0,0 +1 @@
+

ovos-solver-hivemind-plugin-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ovos-solver-hivemind-plugin-0.0.1/setup.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+import os
+
+from setuptools import setup
+
+BASEDIR = os.path.abspath(os.path.dirname(__file__))
+
+with open(f"{BASEDIR}/README.md", "r") as fh:
+    long_desc = fh.read()
+
+
+def get_version():
+    """ Find the version of the package"""
+    version = None
+    version_file = os.path.join(BASEDIR, 'ovos_hivemind_solver', 'version.py')
+    major, minor, build, alpha = (None, None, None, None)
+    with open(version_file) as f:
+        for line in f:
+            if 'VERSION_MAJOR' in line:
+                major = line.split('=')[1].strip()
+            elif 'VERSION_MINOR' in line:
+                minor = line.split('=')[1].strip()
+            elif 'VERSION_BUILD' in line:
+                build = line.split('=')[1].strip()
+            elif 'VERSION_ALPHA' in line:
+                alpha = line.split('=')[1].strip()
+
+            if ((major and minor and build and alpha) or
+                    '# END_VERSION_BLOCK' in line):
+                break
+    version = f"{major}.{minor}.{build}"
+    if int(alpha):
+        version += f"a{alpha}"
+    return version
+
+
+def required(requirements_file):
+    """ Read requirements file and remove comments and empty lines. """
+    with open(os.path.join(BASEDIR, requirements_file), 'r') as f:
+        requirements = f.read().splitlines()
+        if 'MYCROFT_LOOSE_REQUIREMENTS' in os.environ:
+            print('USING LOOSE REQUIREMENTS!')
+            requirements = [r.replace('==', '>=').replace('~=', '>=') for r in requirements]
+        return [pkg for pkg in requirements
+                if pkg.strip() and not pkg.startswith("#")]
+
+
+PLUGIN_ENTRY_POINT = 'ovos-solver-hivemind-plugin=ovos_hivemind_solver:HiveMindSolver'
+setup(
+    name='ovos-solver-hivemind-plugin',
+    version=get_version(),
+    description='A question solver plugin for OVOS',
+    url='https://github.com/JarbasHiveMind/ovos-solver-hivemind-plugin',
+    author='jarbasai',
+    author_email='jarbasai@mailfence.com',
+    license='MIT',
+    packages=['ovos_hivemind_solver'],
+    zip_safe=True,
+    keywords='OVOS openvoiceos plugin utterance fallback query',
+    entry_points={'neon.plugin.solver': PLUGIN_ENTRY_POINT},
+    install_requires=required("requirements.txt"),
+    long_description=long_desc,
+    long_description_content_type='text/markdown'
+)