ovos-skill-randomness 0.0.3a1__tar.gz

ovos-skill-randomness-0.0.3a1/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.1
+Name: ovos-skill-randomness
+Version: 0.0.3a1
+Summary: UNKNOWN
+Home-page: https://github.com/openvoiceos/skill-ovos-randomness
+Author: OpenVoiceOS
+Author-email: mike@oscillatelabs.net
+License: MIT
+Description: # skill-randomness
+        
+        ![Python](https://img.shields.io/badge/python-3.9-blue.svg)
+        ![Python](https://img.shields.io/badge/python-3.10-blue.svg)
+        ![Python](https://img.shields.io/badge/python-3.11-blue.svg)
+        
+        **Does not support Python 3.8 or lower, please use Python 3.9-3.11**
+        
+        ## About
+        
+        A skill for all kinds of chance - make a choice, roll a die, flip a coin, pick between two choices, etc.
+        
+        Accepts a single property: `die_limit`, which is the maximum number of dice that can be rolled at once. The default is 16.
+        
+        `~/.config/mycroft/skills/skill-randomness.openvoiceos/settings.json`
+        
+        ```json
+        {
+          "die_limit": 16
+        }
+        ```
+        
+        ## Examples
+        
+        - "Flip a coin"
+        - "Tell me my future"
+        - "Help me decide something"
+        - "Pick a number between 1 and 100"
+        - "Roll a die"
+        - "Roll 1 d 20"
+        - "Roll 6 d 8"
+        - "Roll a 20 sided die"
+        - "Roll 5 dice"
+        - "Roll 6, 8 sided dice"
+        
+        ## Credits
+        
+        - Mike Gray (@mikejgray)
+        - BuilderJer (@builderjer)
+        
+        ## Category
+        
+        Games
+        Fun
+        Chance
+        
+        ## Tags
+        
+        ovos skill games fun chance
+        
+        ## Attribution
+        
+        The coin flipping sound came from [TheKnave at freesound.org](https://freesound.org/people/TheKnave/sounds/435621/). It is licensed under the [Creative Commons 4 License](https://creativecommons.org/licenses/by-nc/4.0/).
+        
+        The fortune teller sound came from [LittleRainySeasons at freesound.org](https://freesound.org/people/LittleRainySeasons/sounds/335354/). It is licensed under the [Creative Commons 0 License](https://creativecommons.org/publicdomain/zero/1.0/).
+        
+        The dice rolling sound came from [dermotte at freesound.org](https://freesound.org/people/dermotte/sounds/220741/). It is licensed under the [Creative Commons 4 License](https://creativecommons.org/licenses/by/4.0/).
+        
+Keywords: ovos skill voice assistant
+Platform: UNKNOWN
+Description-Content-Type: text/markdown
+Provides-Extra: test

ovos-skill-randomness-0.0.3a1/README.md

@@ -0,0 +1,57 @@
+# skill-randomness
+
+![Python](https://img.shields.io/badge/python-3.9-blue.svg)
+![Python](https://img.shields.io/badge/python-3.10-blue.svg)
+![Python](https://img.shields.io/badge/python-3.11-blue.svg)
+
+**Does not support Python 3.8 or lower, please use Python 3.9-3.11**
+
+## About
+
+A skill for all kinds of chance - make a choice, roll a die, flip a coin, pick between two choices, etc.
+
+Accepts a single property: `die_limit`, which is the maximum number of dice that can be rolled at once. The default is 16.
+
+`~/.config/mycroft/skills/skill-randomness.openvoiceos/settings.json`
+
+```json
+{
+  "die_limit": 16
+}
+```
+
+## Examples
+
+- "Flip a coin"
+- "Tell me my future"
+- "Help me decide something"
+- "Pick a number between 1 and 100"
+- "Roll a die"
+- "Roll 1 d 20"
+- "Roll 6 d 8"
+- "Roll a 20 sided die"
+- "Roll 5 dice"
+- "Roll 6, 8 sided dice"
+
+## Credits
+
+- Mike Gray (@mikejgray)
+- BuilderJer (@builderjer)
+
+## Category
+
+Games
+Fun
+Chance
+
+## Tags
+
+ovos skill games fun chance
+
+## Attribution
+
+The coin flipping sound came from [TheKnave at freesound.org](https://freesound.org/people/TheKnave/sounds/435621/). It is licensed under the [Creative Commons 4 License](https://creativecommons.org/licenses/by-nc/4.0/).
+
+The fortune teller sound came from [LittleRainySeasons at freesound.org](https://freesound.org/people/LittleRainySeasons/sounds/335354/). It is licensed under the [Creative Commons 0 License](https://creativecommons.org/publicdomain/zero/1.0/).
+
+The dice rolling sound came from [dermotte at freesound.org](https://freesound.org/people/dermotte/sounds/220741/). It is licensed under the [Creative Commons 4 License](https://creativecommons.org/licenses/by/4.0/).

ovos-skill-randomness-0.0.3a1/ovos_skill_randomness.egg-info/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.1
+Name: ovos-skill-randomness
+Version: 0.0.3a1
+Summary: UNKNOWN
+Home-page: https://github.com/openvoiceos/skill-ovos-randomness
+Author: OpenVoiceOS
+Author-email: mike@oscillatelabs.net
+License: MIT
+Description: # skill-randomness
+        
+        ![Python](https://img.shields.io/badge/python-3.9-blue.svg)
+        ![Python](https://img.shields.io/badge/python-3.10-blue.svg)
+        ![Python](https://img.shields.io/badge/python-3.11-blue.svg)
+        
+        **Does not support Python 3.8 or lower, please use Python 3.9-3.11**
+        
+        ## About
+        
+        A skill for all kinds of chance - make a choice, roll a die, flip a coin, pick between two choices, etc.
+        
+        Accepts a single property: `die_limit`, which is the maximum number of dice that can be rolled at once. The default is 16.
+        
+        `~/.config/mycroft/skills/skill-randomness.openvoiceos/settings.json`
+        
+        ```json
+        {
+          "die_limit": 16
+        }
+        ```
+        
+        ## Examples
+        
+        - "Flip a coin"
+        - "Tell me my future"
+        - "Help me decide something"
+        - "Pick a number between 1 and 100"
+        - "Roll a die"
+        - "Roll 1 d 20"
+        - "Roll 6 d 8"
+        - "Roll a 20 sided die"
+        - "Roll 5 dice"
+        - "Roll 6, 8 sided dice"
+        
+        ## Credits
+        
+        - Mike Gray (@mikejgray)
+        - BuilderJer (@builderjer)
+        
+        ## Category
+        
+        Games
+        Fun
+        Chance
+        
+        ## Tags
+        
+        ovos skill games fun chance
+        
+        ## Attribution
+        
+        The coin flipping sound came from [TheKnave at freesound.org](https://freesound.org/people/TheKnave/sounds/435621/). It is licensed under the [Creative Commons 4 License](https://creativecommons.org/licenses/by-nc/4.0/).
+        
+        The fortune teller sound came from [LittleRainySeasons at freesound.org](https://freesound.org/people/LittleRainySeasons/sounds/335354/). It is licensed under the [Creative Commons 0 License](https://creativecommons.org/publicdomain/zero/1.0/).
+        
+        The dice rolling sound came from [dermotte at freesound.org](https://freesound.org/people/dermotte/sounds/220741/). It is licensed under the [Creative Commons 4 License](https://creativecommons.org/licenses/by/4.0/).
+        
+Keywords: ovos skill voice assistant
+Platform: UNKNOWN
+Description-Content-Type: text/markdown
+Provides-Extra: test

ovos-skill-randomness-0.0.3a1/ovos_skill_randomness.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+setup.py
+ovos_skill_randomness.egg-info/PKG-INFO
+ovos_skill_randomness.egg-info/SOURCES.txt
+ovos_skill_randomness.egg-info/dependency_links.txt
+ovos_skill_randomness.egg-info/entry_points.txt
+ovos_skill_randomness.egg-info/requires.txt
+ovos_skill_randomness.egg-info/top_level.txt
+skill_randomness/__init__.py
+skill_randomness/version.py
+test/test_skill.py

ovos-skill-randomness-0.0.3a1/ovos_skill_randomness.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ovos-skill-randomness-0.0.3a1/ovos_skill_randomness.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[ovos.plugin.skill]
+skill-ovos-randomness.openvoiceos=skill_ovos_randomness:RandomnessSkill
+

ovos-skill-randomness-0.0.3a1/ovos_skill_randomness.egg-info/requires.txt

@@ -0,0 +1,9 @@
+ovos-utils
+ovos-workshop
+ovos-lingua_franca
+icepool
+
+[test]
+pytest
+ovos-plugin-manager
+padacioso

ovos-skill-randomness-0.0.3a1/ovos_skill_randomness.egg-info/top_level.txt

@@ -0,0 +1 @@
+skill_ovos_randomness

ovos-skill-randomness-0.0.3a1/setup.cfg

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

ovos-skill-randomness-0.0.3a1/setup.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+from setuptools import setup
+from os import walk, path
+
+BASEDIR = path.abspath(path.dirname(__file__))
+URL = "https://github.com/openvoiceos/skill-ovos-randomness"
+SKILL_CLAZZ = "RandomnessSkill"  # needs to match __init__.py class name
+PYPI_NAME = "ovos-skill-randomness"  # pip install PYPI_NAME
+
+# below derived from github url to ensure standard skill_id
+SKILL_AUTHOR, SKILL_NAME = URL.split(".com/")[-1].split("/")
+SKILL_PKG = SKILL_NAME.lower().replace("-", "_")
+PLUGIN_ENTRY_POINT = f"{SKILL_NAME.lower()}.{SKILL_AUTHOR.lower()}={SKILL_PKG}:{SKILL_CLAZZ}"
+# skill_id=package_name:SkillClass
+BASE_PATH = BASE_PATH = path.abspath(path.join(path.dirname(__file__), "skill_randomness"))
+
+
+def get_version():
+    """Find the version of the package"""
+    version = None
+    version_file = path.join(BASE_PATH, "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
+
+
+def get_requirements(requirements_filename: str):
+    requirements_file = path.join(path.dirname(__file__), requirements_filename)
+    with open(requirements_file, "r", encoding="utf-8") as r:
+        requirements = r.readlines()
+    requirements = [r.strip() for r in requirements if r.strip() and not r.strip().startswith("#")]
+    return requirements
+
+
+def find_resource_files():
+    resource_base_dirs = ("locale", "intents", "dialog", "vocab", "regex", "ui")
+    package_data = ["*.json", "*.wav", "*.mp3"]
+    for res in resource_base_dirs:
+        if path.isdir(path.join(BASE_PATH, res)):
+            for directory, _, files in walk(path.join(BASE_PATH, res)):
+                if files:
+                    package_data.append(path.join(directory.replace(BASE_PATH, "").lstrip("/"), "*"))
+    return package_data
+
+
+with open(path.join(path.abspath(path.dirname(__file__)), "README.md"), "r") as f:
+    long_description = f.read()
+
+setup(
+    name=PYPI_NAME,
+    version=get_version(),
+    description="",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url=URL,
+    author="OpenVoiceOS",
+    author_email="mike@oscillatelabs.net",
+    license="MIT",
+    package_dir={SKILL_PKG: "skill_randomness"},
+    package_data={SKILL_PKG: find_resource_files()},
+    packages=[SKILL_PKG],
+    include_package_data=True,
+    install_requires=get_requirements("requirements.txt"),
+    keywords="ovos skill voice assistant",
+    entry_points={"ovos.plugin.skill": PLUGIN_ENTRY_POINT},
+    extras_require={"test": get_requirements("requirements-dev.txt")},
+)

ovos-skill-randomness-0.0.3a1/skill_randomness/__init__.py

@@ -0,0 +1,107 @@
+"""A skill for all kinds of chance - make a choice, roll a die, flip a coin, etc."""
+from os.path import dirname
+from random import randint
+from typing import List
+
+from icepool import Die, d
+
+from ovos_bus_client.message import Message
+from ovos_workshop.decorators import intent_handler
+from lingua_franca.parse import extract_number
+from ovos_workshop.skills import OVOSSkill
+
+class RandomnessSkill(OVOSSkill):
+    """A skill for all kinds of chance - make a choice, roll a die, flip a coin, etc."""
+
+    @property
+    def die_limit(self):
+        return self.settings.get("die_limit", 16)
+
+    @intent_handler("make-a-choice.intent")
+    def handle_make_a_choice_intent(self, message: Message):  # pylint: disable=unused-argument
+        """Decide between two things."""
+        first_choice = self.get_response("first-choice") or "the first one"
+        second_choice = self.get_response("second-choice") or "the second one"
+        try:
+            result = Die([first_choice, second_choice]).sample()
+        except TypeError:
+            result = Die(first_choice, second_choice).sample()
+        self.speak_dialog("choice-result", data={"choice": result})
+        self.gui.show_text(result)
+        self.enclosure.eyes_blink("b")
+        self.enclosure.mouth_text(result)
+
+    @intent_handler("pick-a-number.intent")
+    def handle_pick_a_number(self, message: Message):
+        """Pick a number between two numbers."""
+        lower_bound = message.data.get("lower", "")
+        upper_bound = message.data.get("upper", "")
+        self.log.debug(f"Lower: {lower_bound}, Upper: {upper_bound}")
+        try:
+            upper_bound = round(float(upper_bound))
+            lower_bound = round(float(lower_bound))
+        except ValueError:
+            lower_bound = 1
+            upper_bound = 10
+            self.speak_dialog("number-range-not-specified")
+        result = randint(lower_bound, upper_bound)
+        self.speak_dialog("number-result", data={"number": result})
+        self.gui.show_text(str(result))
+        self.enclosure.eyes_spin()
+        self.enclosure.mouth_text(str(result))
+
+    @intent_handler("flip-a-coin.intent")
+    def handle_flip_a_coin(self, message: Message):  # pylint: disable=unused-argument
+        """Flip a coin."""
+        self.play_audio(f"{dirname(__file__)}/coin-flip.wav")
+        try:
+            result = Die(["heads", "tails"]).sample()
+        except TypeError:
+            result = Die("heads", "tails").sample()
+        self.speak_dialog("coin-result", data={"result": result})
+        self.gui.show_text(result)
+        self.enclosure.system_blink(3)
+        self.enclosure.mouth_text(result)
+
+    @intent_handler("fortune-teller.intent")
+    def handle_fortune_teller(self, message: Message):  # pylint: disable=unused-argument
+        """Get a random fortune."""
+        self.play_audio(f"{dirname(__file__)}/magic.mp3")
+        fortune = self.get_response("fortune-query")
+        try:
+            answer = Die(["yes", "no"]).sample()
+        except TypeError:
+            answer = Die("yes", "no").sample()
+        self.speak_dialog("fortune-result", {"answer": answer})
+        fortune_with_answer = f"{fortune}? ...{answer}"
+        self.gui.show_text(fortune_with_answer)
+        self.enclosure.eyes_spin()
+        self.enclosure.mouth_text(fortune_with_answer)
+
+    @intent_handler("roll-single-die.intent")
+    def handle_roll_single_die(self, message: Message):
+        """Roll a single die."""
+        faces = extract_number(message.data.get("faces", "6"))
+        self.play_audio(f"{dirname(__file__)}/die-roll.wav")
+        self.log.debug(f"Rolling a die with {faces} faces")
+        result = Die(d(int(faces))).sample()
+        self.speak_dialog("die-result", data={"result": result})
+        self.gui.show_text(str(result))
+        self.enclosure.eyes_spin()
+        self.enclosure.mouth_text(str(result))
+
+    @intent_handler("roll-multiple-dice.intent")
+    def handle_roll_multiple_dice(self, message: Message):
+        """Roll multiple dice."""
+        number = extract_number(message.data.get("number"))
+        faces = extract_number(message.data.get("faces", "6"))
+        self.play_audio(f"{dirname(__file__)}/die-roll.wav")
+        if number > self.die_limit:
+            self.speak_dialog("over-dice-limit", data={"number": self.die_limit})
+            number = self.die_limit
+        self.log.debug(f"Rolling {number} dice with {faces} faces")
+        result_list: List[int] = []
+        for _ in range(1, int(number) + 1):
+            val = Die(d(int(faces))).sample()
+            result_list.append(val)
+        self.speak_dialog("multiple-die-result", data={"result_string": ", ".join([str(x) for x in result_list]), "result_total": str(sum(result_list))})

ovos-skill-randomness-0.0.3a1/skill_randomness/version.py

@@ -0,0 +1,9 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 3
+VERSION_ALPHA = 1
+# END_VERSION_BLOCKVERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 1
+VERSION_ALPHA = 0

ovos-skill-randomness-0.0.3a1/test/test_skill.py

@@ -0,0 +1,61 @@
+# pylint: disable=missing-docstring
+import shutil
+from json import dumps
+from os import environ, getenv, makedirs
+from os.path import join, dirname, isdir
+from unittest.mock import Mock
+import pytest
+from ovos_plugin_manager.skills import find_skill_plugins
+from ovos_utils.fakebus import FakeBus
+
+from skill_randomness import RandomnessSkill
+
+
+@pytest.fixture(scope="session")
+def test_skill(test_skill_id="skill-ovos-randomness.openvoiceos", bus=FakeBus()):
+    # Get test skill
+    bus.emitter = bus.ee
+    bus.run_forever()
+    skill_entrypoint = getenv("TEST_SKILL_ENTRYPOINT")
+    if not skill_entrypoint:
+        skill_entrypoints = list(find_skill_plugins().keys())
+        assert test_skill_id in skill_entrypoints
+        skill_entrypoint = test_skill_id
+
+    skill = RandomnessSkill(skill_id=test_skill_id, bus=bus)
+    skill.speak = Mock()
+    skill.speak_dialog = Mock()
+    skill.play_audio = Mock()
+    yield skill
+    shutil.rmtree(join(dirname(__file__), "skill_fs"), ignore_errors=False)
+
+
+@pytest.fixture(scope="function")
+def reset_skill_mocks(test_skill):
+    # Reset mocks before each test
+    test_skill.speak.reset_mock()
+    test_skill.speak_dialog.reset_mock()
+    test_skill.play_audio.reset_mock()
+
+
+class TestRandomnessSkill:
+    test_fs = join(dirname(__file__), "skill_fs")
+    data_dir = join(test_fs, "data")
+    conf_dir = join(test_fs, "config")
+    environ["XDG_DATA_HOME"] = data_dir
+    environ["XDG_CONFIG_HOME"] = conf_dir
+    if not isdir(test_fs):
+        makedirs(data_dir)
+        makedirs(conf_dir)
+
+    with open(join(conf_dir, "mycroft.conf"), "w", encoding="utf-8") as f:
+        f.write(dumps({"Audio": {"backends": {"ocp": {"active": False}}}}))
+
+    def test_nada(self, test_skill):
+        assert True
+
+def test_skill_is_a_valid_plugin():
+    assert "skill-ovos-randomness.openvoiceos" in find_skill_plugins()
+
+if __name__ == "__main__":
+    pytest.main()