ovos-skill-boot-finished 0.2.1__tar.gz

ovos-skill-boot-finished-0.2.1/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ovos-skill-boot-finished-0.2.1/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: ovos-skill-boot-finished
+Version: 0.2.1
+Summary: OVOS finished booting skill
+Home-page: https://github.com/OpenVoiceOS/skill-ovos-boot-finished
+Author: OpenVoiceOS
+Author-email: jarbasai@mailfence.com
+License: Apache-2.0
+Description: # Finished Booting
+        
+        ## Summary
+        
+        Skill to speak when OVOS is ready
+        
+        ## Description
+        
+        When OpenVoiceOS is started or restarted, this skill will speak a notification to the
+        user. This speech can be enabled/disabled by intent.
+        
+        ## Examples
+        
+        - "Enable ready notifications."
+        - "Disable load speech."
+        
+        ## Credits
+        [NeonGeckoCom](https://github.com/NeonGeckoCom/skill-core_ready)
+        
+        ## Category
+        **Daily**
+        
+Keywords: ovos skill plugin
+Platform: UNKNOWN
+Description-Content-Type: text/markdown

ovos-skill-boot-finished-0.2.1/README.md

@@ -0,0 +1,21 @@
+# Finished Booting
+
+## Summary
+
+Skill to speak when OVOS is ready
+
+## Description
+
+When OpenVoiceOS is started or restarted, this skill will speak a notification to the
+user. This speech can be enabled/disabled by intent.
+
+## Examples
+
+- "Enable ready notifications."
+- "Disable load speech."
+
+## Credits
+[NeonGeckoCom](https://github.com/NeonGeckoCom/skill-core_ready)
+
+## Category
+**Daily**

ovos-skill-boot-finished-0.2.1/__init__.py

@@ -0,0 +1,80 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2022 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Guy Daniels, Elon Gasper, Richard Leeds,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+from ovos_bus_client.message import Message
+from ovos_workshop.skills import OVOSSkill
+from ovos_workshop.decorators import intent_handler
+from ovos_utils.log import LOG
+
+
+class BootFinishedSkill(OVOSSkill):
+    def initialize(self):
+        self.add_event("mycroft.ready", self.handle_ready)
+
+    @property
+    def speak_ready(self):
+        """
+        Speak `ready` dialog when ready unless disabled in settings
+        """
+        return self.settings.get("speak_ready", True)
+        
+    @property
+    def ready_sound(self):
+        """
+        play sound when ready unless disabled in settings
+        """
+        return self.settings.get("ready_sound", True)
+                                 
+    def handle_ready(self, message: Message):
+        """
+        Handle mycroft.ready event. Notify the user everything is ready if
+        configured.
+        """
+        if self.ready_sound:
+            self.acknowledge()
+        self.enclosure.eyes_on()
+        if self.speak_ready:
+            self.speak_dialog("ready")
+        else:
+            LOG.debug("Ready notification disabled in settings")
+        self.enclosure.eyes_blink("b")
+
+    @intent_handler("enable_ready_notification.intent")
+    def handle_enable_notification(self, message: Message):
+        """
+        Handle a request to enable ready announcements
+        """
+        self.settings["speak_ready"] = True
+        self.speak_dialog("confirm_speak_ready")
+
+    @intent_handler("disable_ready_notification.intent")
+    def handle_disable_notification(self, message: Message):
+        """
+        Handle a request to disable ready announcements
+        """
+        self.settings["speak_ready"] = False
+        self.speak_dialog("confirm_no_speak_ready")

ovos-skill-boot-finished-0.2.1/ovos_skill_boot_finished.egg-info/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: ovos-skill-boot-finished
+Version: 0.2.1
+Summary: OVOS finished booting skill
+Home-page: https://github.com/OpenVoiceOS/skill-ovos-boot-finished
+Author: OpenVoiceOS
+Author-email: jarbasai@mailfence.com
+License: Apache-2.0
+Description: # Finished Booting
+        
+        ## Summary
+        
+        Skill to speak when OVOS is ready
+        
+        ## Description
+        
+        When OpenVoiceOS is started or restarted, this skill will speak a notification to the
+        user. This speech can be enabled/disabled by intent.
+        
+        ## Examples
+        
+        - "Enable ready notifications."
+        - "Disable load speech."
+        
+        ## Credits
+        [NeonGeckoCom](https://github.com/NeonGeckoCom/skill-core_ready)
+        
+        ## Category
+        **Daily**
+        
+Keywords: ovos skill plugin
+Platform: UNKNOWN
+Description-Content-Type: text/markdown

ovos-skill-boot-finished-0.2.1/ovos_skill_boot_finished.egg-info/SOURCES.txt

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

ovos-skill-boot-finished-0.2.1/ovos_skill_boot_finished.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ovos-skill-boot-finished-0.2.1/ovos_skill_boot_finished.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[ovos.plugin.skill]
+skill-ovos-boot-finished.openvoiceos=skill_ovos_boot_finished:BootFinishedSkill
+

ovos-skill-boot-finished-0.2.1/ovos_skill_boot_finished.egg-info/top_level.txt

@@ -0,0 +1 @@
+skill_ovos_boot_finished

ovos-skill-boot-finished-0.2.1/setup.cfg

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

ovos-skill-boot-finished-0.2.1/setup.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+import os
+from setuptools import setup
+from os import walk, path
+
+URL = "https://github.com/OpenVoiceOS/skill-ovos-boot-finished"
+SKILL_CLAZZ = "BootFinishedSkill"  # needs to match __init__.py class name
+PYPI_NAME = "ovos-skill-boot-finished"  # 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
+
+
+def find_resource_files():
+    resource_base_dirs = ("locale", "ui", "vocab", "dialog", "regex", "skill")
+    base_dir = path.dirname(__file__)
+    package_data = ["*.json"]
+    for res in resource_base_dirs:
+        if path.isdir(path.join(base_dir, res)):
+            for (directory, _, files) in walk(path.join(base_dir, res)):
+                if files:
+                    package_data.append(
+                        path.join(directory.replace(base_dir, "").lstrip('/'),
+                                  '*'))
+    return package_data
+
+
+with open(path.join(path.abspath(path.dirname(__file__)), "README.md"), "r") as f:
+    long_description = f.read()
+
+
+def get_version():
+    """ Find the version of this skill"""
+    version_file = os.path.join(os.path.dirname(__file__), '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
+
+
+setup(
+    name=PYPI_NAME,
+    version=get_version(),
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url=URL,
+    author=SKILL_AUTHOR,
+    description='OVOS finished booting skill',
+    author_email='jarbasai@mailfence.com',
+    license='Apache-2.0',
+    package_dir={SKILL_PKG: ""},
+    package_data={SKILL_PKG: find_resource_files()},
+    packages=[SKILL_PKG],
+    include_package_data=True,
+    keywords='ovos skill plugin',
+    entry_points={'ovos.plugin.skill': PLUGIN_ENTRY_POINT}
+)

ovos-skill-boot-finished-0.2.1/test/test_skill.py

@@ -0,0 +1,50 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2022 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Guy Daniels, Elon Gasper, Richard Leeds,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from ovos_bus_client import Message
+from neon_minerva.tests.skill_unit_test_base import SkillTestCase
+
+
+class TestSkill(SkillTestCase):
+    def test_skill_init(self):
+        self.assertGreaterEqual(
+            len(self.skill.bus.ee.listeners("mycroft.ready")), 1)
+        self.assertTrue(self.skill.speak_ready)
+
+    def test_handle_enable_notification(self):
+        self.skill.settings['speak_ready'] = False
+        self.skill.handle_enable_notification(Message(""))
+        self.assertTrue(self.skill.speak_ready)
+        self.skill.speak_dialog.assert_called_once_with("confirm_speak_ready")
+
+    def test_handle_disable_notification(self):
+        self.skill.settings['speak_ready'] = True
+        self.skill.handle_disable_notification(Message(""))
+        self.assertFalse(self.skill.speak_ready)
+        self.skill.speak_dialog.assert_called_once_with(
+            "confirm_no_speak_ready")

ovos-skill-boot-finished-0.2.1/version.py

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