From 9a9f74a44432703a0d928d1b289bf49daf46011c Mon Sep 17 00:00:00 2001 From: JarbasAI <33701864+JarbasAl@users.noreply.github.com> Date: Mon, 18 Nov 2024 12:33:07 +0000 Subject: [PATCH] feat: :tada: (#1) * feat: :tada: * add skill examples * add skill examples --- LICENSE | 202 ++++++++++++++++++++++++++ MANIFEST.in | 2 + README.md | 9 ++ __init__.py | 66 +++++++++ locale/en-us/screenshot.failed.dialog | 2 + locale/en-us/screenshot.taken.dialog | 1 + locale/en-us/skill.json | 10 ++ locale/en-us/take.screenshot.intent | 6 +- requirements.txt | 2 + setup.py | 89 ++++++++++++ translations/en-us/dialogs.json | 9 ++ translations/en-us/intents.json | 12 +- version.py | 6 + 13 files changed, 411 insertions(+), 5 deletions(-) create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.md create mode 100644 __init__.py create mode 100644 locale/en-us/screenshot.failed.dialog create mode 100644 locale/en-us/screenshot.taken.dialog create mode 100644 locale/en-us/skill.json create mode 100644 requirements.txt create mode 100644 setup.py create mode 100644 translations/en-us/dialogs.json create mode 100644 version.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1486acc --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 2024 Casimiro Ferreira + + 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. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..fb05bf3 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include locale * +include *.txt \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..50456ff --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Screenshot Skill + +Take screenshots by voice + +> **Supported platforms**: ovos-shell, Windows, macOS, Linux, and OpenBSD + +## Examples +* "take a screenshot" +* "capture the screen", diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..cc57c42 --- /dev/null +++ b/__init__.py @@ -0,0 +1,66 @@ +# 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. +import os +import time + +import mss +from ovos_config import Configuration +from ovos_utils.log import LOG + +from ovos_workshop.decorators import intent_handler +from ovos_workshop.skills import OVOSSkill + + +class ScreenshotSkill(OVOSSkill): + + def initialize(self): + self.add_event("ovos.display.screenshot.get.response", + self.handle_screenshot_taken) + + @property + def is_ovos_shell(self) -> bool: + return Configuration().get("gui", {}).get("extension", "") == "ovos-gui-plugin-shell-companion" + + @property + def screenshots_folder(self) -> str: + p = self.settings.get("screenshots_path") or "~/Pictures/Screenshots" + p = os.path.expanduser(p) + os.makedirs(p, exist_ok=True) + return p + + def notify(self, output): + display_message = f"Screenshot saved to {output}" + self.gui.show_notification(display_message) + LOG.debug(f"screenshot saved: {output}") + self.speak_dialog("screenshot.taken") + + def handle_screenshot_taken(self, message): + result = message.data.get("result") + self.notify(result) + + @intent_handler("take.screenshot.intent") + def handle_screenshot_intent(self, message): + if self.is_ovos_shell: + LOG.debug("Taking screenshot via ovos-shell") + self.bus.emit(message.forward("ovos.display.screenshot.get", + {"folderpath": self.screenshots_folder})) + return + + output = os.path.join(self.screenshots_folder, f"{time.time()}.png") + try: + with mss.mss() as sct: + screenshot = sct.shot(output=output) + self.notify(output) + except Exception as e: + LOG.error(f"Failed to take screenshot: {e}") + self.speak_dialog("screenshot.failed") + diff --git a/locale/en-us/screenshot.failed.dialog b/locale/en-us/screenshot.failed.dialog new file mode 100644 index 0000000..95b7100 --- /dev/null +++ b/locale/en-us/screenshot.failed.dialog @@ -0,0 +1,2 @@ +screenshot failed +I was unable to take the screenshot. \ No newline at end of file diff --git a/locale/en-us/screenshot.taken.dialog b/locale/en-us/screenshot.taken.dialog new file mode 100644 index 0000000..b215c5b --- /dev/null +++ b/locale/en-us/screenshot.taken.dialog @@ -0,0 +1 @@ +screenshot taken \ No newline at end of file diff --git a/locale/en-us/skill.json b/locale/en-us/skill.json new file mode 100644 index 0000000..54f74b2 --- /dev/null +++ b/locale/en-us/skill.json @@ -0,0 +1,10 @@ +{ + "examples": [ + "take screenshot", + "take a screenshot", + "capture the screen", + "screenshot the display", + "save a screenshot", + "grab the screen" + ] +} \ No newline at end of file diff --git a/locale/en-us/take.screenshot.intent b/locale/en-us/take.screenshot.intent index 9e12b15..6c6d11d 100644 --- a/locale/en-us/take.screenshot.intent +++ b/locale/en-us/take.screenshot.intent @@ -1,2 +1,6 @@ take a screenshot -take screenshot \ No newline at end of file +take screenshot +capture the screen +screenshot the display +save a screenshot +grab the screen diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c79792c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +mss +ovos-workshop \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..828d927 --- /dev/null +++ b/setup.py @@ -0,0 +1,89 @@ +#!/usr/bin/env python3 +import os +from os import walk, path +from os.path import abspath, dirname, join, isfile, isdir + +from setuptools import setup + +URL = "https://github.com/OpenVoiceOS/ovos-skill-screenshot" +SKILL_CLAZZ = "ScreenshotSkill" # needs to match __init__.py class name +PYPI_NAME = "ovos-skill-screenshot" # 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",) + base_dir = abspath(dirname(__file__)) + package_data = ["*.json"] + for res in resource_base_dirs: + if isdir(join(base_dir, res)): + for (directory, _, files) in walk(join(base_dir, res)): + if files: + package_data.append(join(directory.replace(base_dir, "").lstrip('/'), '*')) + return package_data + + +def get_requirements(requirements_filename: str = "requirements.txt"): + requirements_file = join(abspath(dirname(__file__)), requirements_filename) + if isfile(requirements_file): + 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("#")] + if 'MYCROFT_LOOSE_REQUIREMENTS' in os.environ: + print('USING LOOSE REQUIREMENTS!') + requirements = [r.replace('==', '>=').replace('~=', '>=') for r in requirements] + return requirements + return [] + + +def get_version(): + """ Find the version of this skill""" + version_file = join(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 + + +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(), + long_description=long_description, + long_description_content_type="text/markdown", + url=URL, + install_requires=get_requirements("requirements.txt"), + author="jarbasAi", + description='OVOS screenshot skill plugin', + 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} +) diff --git a/translations/en-us/dialogs.json b/translations/en-us/dialogs.json new file mode 100644 index 0000000..1406195 --- /dev/null +++ b/translations/en-us/dialogs.json @@ -0,0 +1,9 @@ +{ + "screenshot.taken.dialog": [ + "screenshot taken" + ], + "screenshot.failed.dialog": [ + "screenshot failed", + "I was unable to take the screenshot" + ] +} \ No newline at end of file diff --git a/translations/en-us/intents.json b/translations/en-us/intents.json index a2123c3..732e0f9 100644 --- a/translations/en-us/intents.json +++ b/translations/en-us/intents.json @@ -1,6 +1,10 @@ { - "take.screenshot.intent": [ - "take screenshot", - "take a screenshot" - ] + "take.screenshot.intent": [ + "take screenshot", + "take a screenshot", + "capture the screen", + "screenshot the display", + "save a screenshot", + "grab the screen" + ] } \ No newline at end of file diff --git a/version.py b/version.py new file mode 100644 index 0000000..3b6b9b5 --- /dev/null +++ b/version.py @@ -0,0 +1,6 @@ +# START_VERSION_BLOCK +VERSION_MAJOR = 0 +VERSION_MINOR = 0 +VERSION_BUILD = 1 +VERSION_ALPHA = 1 +# END_VERSION_BLOCK