ovos-solver-rivescript-plugin 0.0.0__tar.gz → 0.0.1__tar.gz

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

@@ -0,0 +1,40 @@
+Metadata-Version: 2.1
+Name: ovos-solver-rivescript-plugin
+Version: 0.0.1
+Summary: A question solver plugin for ovos/neon/mycroft
+Home-page: https://github.com/OpenVoiceOS/ovos-solver-rivescript-plugin
+Author: jarbasai
+Author-email: jarbasai@mailfence.com
+License: MIT
+Keywords: mycroft plugin utterance fallback query
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# <img src='https://raw.githack.com/FortAwesome/Font-Awesome/master/svgs/solid/robot.svg' card_color='#40DBB0' width='50' height='50' style='vertical-align:bottom'/> Rivescript Chatbot
+ 
+Give Mycroft some sass with Rivescript!
+
+Leverages the [Alice chatbot](https://www.chatbots.org/chatbot/a.l.i.c.e/) to create some fun interactions.  Phrases not explicitly handled by other skills will be run by the chatbot, so nearly every interaction will have _some_ response.  But be warned, Mycroft might become a bit obnoxious...
+
+## Examples 
+* "Do you like ice cream"
+* "Do you like dogs"
+* "I have a jump rope"
+
+
+## Usage
+
+Spoken answers api with a Rivescript backend
+
+```python
+from ovos_solver_rivescript_plugin import RivescriptSolver
+
+d = RivescriptSolver()
+sentence = d.spoken_answer("hello")
+print(sentence)
+# Hi there!
+
+sentence = d.spoken_answer("Do you like ice cream", {"lang": "pt-pt"})
+print(sentence)
+# O que queres mesmo saber?
+```

{ovos-solver-rivescript-plugin-0.0.0 → ovos-solver-rivescript-plugin-0.0.1}/ovos_solver_rivescript_plugin/__init__.py

@@ -1,16 +1,17 @@
 import os
-import random
 from datetime import date
-from neon_solvers import AbstractSolver
-from os import listdir, remove as remove_file
-from os.path import dirname, isfile, join, dirname, isdir
+from os.path import dirname, isdir
+from typing import Optional
+
+from ovos_plugin_manager.templates.solvers import QuestionSolver
 from ovos_utils.log import LOG
+from ovos_utils.xdg_utils import xdg_data_home
 from rivescript import RiveScript
 
 
 class RivescriptBot:
     XDG_PATH = f"{xdg_data_home()}/rivescript"
-    makedirs(XDG_PATH, exist_ok=True)
+    os.makedirs(XDG_PATH, exist_ok=True)
 
     def __init__(self, lang="en-us", settings=None):
         self.settings = settings or {}
@@ -80,7 +81,7 @@ class RivescriptBot:
         self.rs.set_variable("website", self.settings["website"])
         self.rs.set_variable("master", self.settings["master"])
         self.rs.set_variable("interests", self.settings["interests"])
-        self.rs.set_variable("name",  self.settings.get("name", "mycroft"))
+        self.rs.set_variable("name", self.settings.get("name", "mycroft"))
 
         self.rs.set_variable("age", str(date.today().year - 2016))
         # TODO - location from mycroft.conf
@@ -96,21 +97,34 @@ class RivescriptBot:
             LOG.error(e)
 
 
-class RivescriptSolver(AbstractSolver):
-    def __init__(self):
-        super().__init__(name="Rivescript", priority=96, enable_cache=False, enable_tx=True)
-        self.brain = RivescriptBot("en-us", self.config)
+class RivescriptSolver(QuestionSolver):
+    def __init__(self, config=None):
+        config = config or {"lang": "en-us"}
+        lang = config.get("lang") or "en-us"
+        if lang != "en-us" and lang not in os.listdir(RivescriptBot.XDG_PATH):
+            config["lang"] = lang = "en-us"
+        super().__init__(config, internal_lang=lang, enable_tx=True, priority=96)
+        self.brain = RivescriptBot(lang, self.config)
         self.brain.load_brain()
 
-    # officially exported Solver methods
-    def get_data(self, query, context=None):
-        return {"answer": self.get_spoken_answer(query, context)}
+    def get_spoken_answer(self, query: str,
+                          lang: Optional[str] = None,
+                          units: Optional[str] = None) -> Optional[str]:
+        """
+        Obtain the spoken answer for a given query.
+
+        Args:
+            query (str): The query text.
+            lang (Optional[str]): Optional language code. Defaults to None.
+            units (Optional[str]): Optional units for the query. Defaults to None.
 
-    def get_spoken_answer(self, query, context=None):
+        Returns:
+            str: The spoken answer as a text response.
+        """
         return self.brain.ask_brain(query)
 
 
 if __name__ == "__main__":
     bot = RivescriptSolver()
     print(bot.get_spoken_answer("hello!"))
-    print(bot.spoken_answer("Qual é a tua comida favorita?", {"lang": "pt-pt"}))
+    print(bot.spoken_answer("Qual é a tua comida favorita?", lang="pt-pt"))

ovos-solver-rivescript-plugin-0.0.1/ovos_solver_rivescript_plugin/version.py

@@ -0,0 +1,6 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 1
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK

ovos-solver-rivescript-plugin-0.0.1/ovos_solver_rivescript_plugin.egg-info/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.1
+Name: ovos-solver-rivescript-plugin
+Version: 0.0.1
+Summary: A question solver plugin for ovos/neon/mycroft
+Home-page: https://github.com/OpenVoiceOS/ovos-solver-rivescript-plugin
+Author: jarbasai
+Author-email: jarbasai@mailfence.com
+License: MIT
+Keywords: mycroft plugin utterance fallback query
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# <img src='https://raw.githack.com/FortAwesome/Font-Awesome/master/svgs/solid/robot.svg' card_color='#40DBB0' width='50' height='50' style='vertical-align:bottom'/> Rivescript Chatbot
+ 
+Give Mycroft some sass with Rivescript!
+
+Leverages the [Alice chatbot](https://www.chatbots.org/chatbot/a.l.i.c.e/) to create some fun interactions.  Phrases not explicitly handled by other skills will be run by the chatbot, so nearly every interaction will have _some_ response.  But be warned, Mycroft might become a bit obnoxious...
+
+## Examples 
+* "Do you like ice cream"
+* "Do you like dogs"
+* "I have a jump rope"
+
+
+## Usage
+
+Spoken answers api with a Rivescript backend
+
+```python
+from ovos_solver_rivescript_plugin import RivescriptSolver
+
+d = RivescriptSolver()
+sentence = d.spoken_answer("hello")
+print(sentence)
+# Hi there!
+
+sentence = d.spoken_answer("Do you like ice cream", {"lang": "pt-pt"})
+print(sentence)
+# O que queres mesmo saber?
+```

ovos-solver-rivescript-plugin-0.0.1/ovos_solver_rivescript_plugin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[neon.plugin.solver]
+ovos-solver-rivescript-plugin = ovos_solver_rivescript_plugin:RivescriptSolver

ovos-solver-rivescript-plugin-0.0.1/ovos_solver_rivescript_plugin.egg-info/requires.txt

@@ -0,0 +1,2 @@
+rivescript
+ovos-plugin-manager<2.0.0,>=0.0.26

{ovos-solver-rivescript-plugin-0.0.0 → ovos-solver-rivescript-plugin-0.0.1}/setup.py

@@ -16,23 +16,36 @@ def required(requirements_file):
                 if pkg.strip() and not pkg.startswith("#")]
 
 
-with open("README.md", "r") as f:
+with open(f"{BASEDIR}/README.md", "r") as f:
     long_description = f.read()
 
-
-with open("./version.py", "r", encoding="utf-8") as v:
-    for line in v.readlines():
-        if line.startswith("__version__"):
-            if '"' in line:
-                version = line.split('"')[1]
-            else:
-                version = line.split("'")[1]
-
+def get_version():
+    """ Find the version of the package"""
+    version_file = os.path.join(BASEDIR, 'ovos_solver_rivescript_plugin', '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 alpha and int(alpha) > 0:
+        version += f"a{alpha}"
+    return version
 
 PLUGIN_ENTRY_POINT = 'ovos-solver-rivescript-plugin=ovos_solver_rivescript_plugin:RivescriptSolver'
 setup(
     name='ovos-solver-rivescript-plugin',
-    version=version,
+    version=get_version(),
     description='A question solver plugin for ovos/neon/mycroft',
     url='https://github.com/OpenVoiceOS/ovos-solver-rivescript-plugin',
     author='jarbasai',

ovos-solver-rivescript-plugin-0.0.0/PKG-INFO

@@ -1,40 +0,0 @@
-Metadata-Version: 2.1
-Name: ovos-solver-rivescript-plugin
-Version: 0.0.0
-Summary: A question solver plugin for ovos/neon/mycroft
-Home-page: https://github.com/OpenVoiceOS/ovos-solver-rivescript-plugin
-Author: jarbasai
-Author-email: jarbasai@mailfence.com
-License: MIT
-Description: # <img src='https://raw.githack.com/FortAwesome/Font-Awesome/master/svgs/solid/robot.svg' card_color='#40DBB0' width='50' height='50' style='vertical-align:bottom'/> Rivescript Chatbot
-         
-        Give Mycroft some sass with Rivescript!
-        
-        Leverages the [Alice chatbot](https://www.chatbots.org/chatbot/a.l.i.c.e/) to create some fun interactions.  Phrases not explicitly handled by other skills will be run by the chatbot, so nearly every interaction will have _some_ response.  But be warned, Mycroft might become a bit obnoxious...
-        
-        ## Examples 
-        * "Do you like ice cream"
-        * "Do you like dogs"
-        * "I have a jump rope"
-        
-        
-        ## Usage
-        
-        Spoken answers api with a Rivescript backend
-        
-        ```python
-        from ovos_solver_rivescript_plugin import RivescriptSolver
-        
-        d = RivescriptSolver()
-        sentence = d.spoken_answer("hello")
-        print(sentence)
-        # Hi there!
-        
-        sentence = d.spoken_answer("Do you like ice cream", {"lang": "pt-pt"})
-        print(sentence)
-        # O que queres mesmo saber?
-        ```
-        
-Keywords: mycroft plugin utterance fallback query
-Platform: UNKNOWN
-Description-Content-Type: text/markdown

ovos-solver-rivescript-plugin-0.0.0/ovos_solver_rivescript_plugin/version.py

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

ovos-solver-rivescript-plugin-0.0.0/ovos_solver_rivescript_plugin.egg-info/PKG-INFO

@@ -1,40 +0,0 @@
-Metadata-Version: 2.1
-Name: ovos-solver-rivescript-plugin
-Version: 0.0.0
-Summary: A question solver plugin for ovos/neon/mycroft
-Home-page: https://github.com/OpenVoiceOS/ovos-solver-rivescript-plugin
-Author: jarbasai
-Author-email: jarbasai@mailfence.com
-License: MIT
-Description: # <img src='https://raw.githack.com/FortAwesome/Font-Awesome/master/svgs/solid/robot.svg' card_color='#40DBB0' width='50' height='50' style='vertical-align:bottom'/> Rivescript Chatbot
-         
-        Give Mycroft some sass with Rivescript!
-        
-        Leverages the [Alice chatbot](https://www.chatbots.org/chatbot/a.l.i.c.e/) to create some fun interactions.  Phrases not explicitly handled by other skills will be run by the chatbot, so nearly every interaction will have _some_ response.  But be warned, Mycroft might become a bit obnoxious...
-        
-        ## Examples 
-        * "Do you like ice cream"
-        * "Do you like dogs"
-        * "I have a jump rope"
-        
-        
-        ## Usage
-        
-        Spoken answers api with a Rivescript backend
-        
-        ```python
-        from ovos_solver_rivescript_plugin import RivescriptSolver
-        
-        d = RivescriptSolver()
-        sentence = d.spoken_answer("hello")
-        print(sentence)
-        # Hi there!
-        
-        sentence = d.spoken_answer("Do you like ice cream", {"lang": "pt-pt"})
-        print(sentence)
-        # O que queres mesmo saber?
-        ```
-        
-Keywords: mycroft plugin utterance fallback query
-Platform: UNKNOWN
-Description-Content-Type: text/markdown

ovos-solver-rivescript-plugin-0.0.0/ovos_solver_rivescript_plugin.egg-info/entry_points.txt

@@ -1,3 +0,0 @@
-[neon.plugin.solver]
-ovos-solver-rivescript-plugin=ovos_solver_rivescript_plugin:RivescriptSolver
-

ovos-solver-rivescript-plugin-0.0.0/ovos_solver_rivescript_plugin.egg-info/requires.txt

@@ -1,2 +0,0 @@
-rivescript
-neon_solvers