diff --git a/.github/workflows/auto_translate.yml b/.github/workflows/auto_translate.yml new file mode 100644 index 0000000..2945f94 --- /dev/null +++ b/.github/workflows/auto_translate.yml @@ -0,0 +1,52 @@ +name: Auto translate +on: + workflow_dispatch: + push: + branches: + - dev + +jobs: + translate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + ref: dev + fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.8 + - name: Install Translate Tools + run: | + pip install git+https://github.com/NeonGeckoCom/neon-lang-plugin-libretranslate + - name: Auto Translate + run: | + python scripts/translate.py + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Auto Translate + branch: dev + prepare_skillstore: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + ref: dev + fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.8 + - name: Install OSM + run: | + pip install ovos-skills-manager~=0.0.10 + - name: Update Skill Store metadata + run: | + python scripts/prepare_skillstore.py + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Update skill store metadata + branch: dev diff --git a/.github/workflows/build_tests.yml b/.github/workflows/build_tests.yml new file mode 100644 index 0000000..c3330f6 --- /dev/null +++ b/.github/workflows/build_tests.yml @@ -0,0 +1,44 @@ +name: Run Build Tests +on: + push: + branches: + - master + pull_request: + branches: + - dev + workflow_dispatch: + +jobs: + build_tests: + strategy: + max-parallel: 2 + matrix: + python-version: [ 3.7, 3.8, 3.9, "3.10" ] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Install Build Tools + run: | + python -m pip install build wheel + - name: Install System Dependencies + run: | + sudo apt-get update + sudo apt install python3-dev swig libssl-dev + - name: Build Source Packages + run: | + python setup.py sdist + - name: Build Distribution Packages + run: | + python setup.py bdist_wheel + - name: Install skill + run: | + pip install . + - uses: pypa/gh-action-pip-audit@v1.0.0 + with: + ignore-vulns: | + GHSA-r9hx-vwmv-q579 + PYSEC-2022-43012 diff --git a/.github/workflows/dev2master.yml b/.github/workflows/dev2master.yml new file mode 100644 index 0000000..cc76fee --- /dev/null +++ b/.github/workflows/dev2master.yml @@ -0,0 +1,20 @@ +# This workflow will generate a distribution and upload it to PyPI + +name: Push dev -> master +on: + workflow_dispatch: + +jobs: + build_and_publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. + ref: dev + - name: Push dev -> master + uses: ad-m/github-push-action@master + + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: master \ No newline at end of file diff --git a/.github/workflows/publish_alpha.yml b/.github/workflows/publish_alpha.yml new file mode 100644 index 0000000..1b2ec56 --- /dev/null +++ b/.github/workflows/publish_alpha.yml @@ -0,0 +1,74 @@ +# This workflow will generate a distribution and upload it to PyPI + +name: Publish Alpha Build ...aX +on: + push: + branches: + - dev + paths-ignore: + - 'version.py' + - 'test/**' + - 'examples/**' + - '.github/**' + - '.gitignore' + - 'LICENSE' + - 'CHANGELOG.md' + - 'MANIFEST.in' + - 'readme.md' + - 'scripts/**' + workflow_dispatch: + +jobs: + build_and_publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + ref: dev + fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.8 + - name: Install Build Tools + run: | + python -m pip install build wheel + - name: Increment Version + run: | + VER=$(python setup.py --version) + python scripts/bump_alpha.py + - name: "Generate release changelog" + uses: heinrichreimer/github-changelog-generator-action@v2.3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + maxIssues: 50 + id: changelog + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Increment Version + branch: dev + - name: version + run: echo "::set-output name=version::$(python setup.py --version)" + id: version + - name: Create Release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token + with: + tag_name: V${{ steps.version.outputs.version }} + release_name: Release ${{ steps.version.outputs.version }} + body: | + Changes in this Release + ${{ steps.changelog.outputs.changelog }} + draft: false + prerelease: true + commitish: dev + - name: Build Distribution Packages + run: | + python setup.py bdist_wheel + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{secrets.PYPI_TOKEN}} diff --git a/.github/workflows/publish_build.yml b/.github/workflows/publish_build.yml new file mode 100644 index 0000000..a4b046f --- /dev/null +++ b/.github/workflows/publish_build.yml @@ -0,0 +1,86 @@ +# This workflow will generate a distribution and upload it to PyPI + +name: Publish Build Release ..X +on: + workflow_dispatch: + +jobs: + build_and_publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + ref: dev + fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.8 + - name: Install Build Tools + run: | + python -m pip install build wheel + - name: Remove alpha (declare stable) + run: | + VER=$(python setup.py --version) + python scripts/remove_alpha.py + - name: "Generate release changelog" + uses: heinrichreimer/github-changelog-generator-action@v2.3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + id: changelog + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Declare alpha stable + branch: dev + - name: Push dev -> master + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: master + force: true + - name: version + run: echo "::set-output name=version::$(python setup.py --version)" + id: version + - name: Create Release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token + with: + tag_name: V${{ steps.version.outputs.version }} + release_name: Release ${{ steps.version.outputs.version }} + body: | + Changes in this Release + ${{ steps.changelog.outputs.changelog }} + draft: false + prerelease: false + commitish: dev + - name: Build Distribution Packages + run: | + python setup.py bdist_wheel + - name: Prepare next Build version + run: echo "::set-output name=version::$(python setup.py --version)" + id: alpha + - name: Increment Version ${{ steps.alpha.outputs.version }}Alpha0 + run: | + VER=$(python setup.py --version) + python scripts/bump_build.py + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Prepare Next Version + branch: dev + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{secrets.PYPI_TOKEN}} + - name: Send message to Matrix bots channel + id: matrix-chat-message + uses: fadenb/matrix-chat-message@v0.0.6 + with: + homeserver: 'matrix.org' + token: ${{ secrets.MATRIX_TOKEN }} + channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org' + message: | + New skill-ovos-wordnet release! ${{ steps.version.outputs.version }} diff --git a/.github/workflows/publish_major.yml b/.github/workflows/publish_major.yml new file mode 100644 index 0000000..06b2268 --- /dev/null +++ b/.github/workflows/publish_major.yml @@ -0,0 +1,86 @@ +# This workflow will generate a distribution and upload it to PyPI + +name: Publish Major Release X.0.0 +on: + workflow_dispatch: + +jobs: + build_and_publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + ref: dev + fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.8 + - name: Install Build Tools + run: | + python -m pip install build wheel + - name: Remove alpha (declare stable) + run: | + VER=$(python setup.py --version) + python scripts/remove_alpha.py + - name: "Generate release changelog" + uses: heinrichreimer/github-changelog-generator-action@v2.3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + id: changelog + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Declare alpha stable + branch: dev + - name: Push dev -> master + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: master + force: true + - name: version + run: echo "::set-output name=version::$(python setup.py --version)" + id: version + - name: Create Release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token + with: + tag_name: V${{ steps.version.outputs.version }} + release_name: Release ${{ steps.version.outputs.version }} + body: | + Changes in this Release + ${{ steps.changelog.outputs.changelog }} + draft: false + prerelease: false + commitish: master + - name: Build Distribution Packages + run: | + python setup.py bdist_wheel + - name: Prepare next Major version + run: echo "::set-output name=version::$(python setup.py --version)" + id: alpha + - name: Increment Version ${{ steps.alpha.outputs.version }}Alpha0 + run: | + VER=$(python setup.py --version) + python scripts/bump_major.py + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Prepare Next Version + branch: dev + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{secrets.PYPI_TOKEN}} + - name: Send message to Matrix bots channel + id: matrix-chat-message + uses: fadenb/matrix-chat-message@v0.0.6 + with: + homeserver: 'matrix.org' + token: ${{ secrets.MATRIX_TOKEN }} + channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org' + message: | + New skill-ovos-wordnet release! ${{ steps.version.outputs.version }} diff --git a/.github/workflows/publish_minor.yml b/.github/workflows/publish_minor.yml new file mode 100644 index 0000000..e540374 --- /dev/null +++ b/.github/workflows/publish_minor.yml @@ -0,0 +1,86 @@ +# This workflow will generate a distribution and upload it to PyPI + +name: Publish Minor Release .X.0 +on: + workflow_dispatch: + +jobs: + build_and_publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + ref: dev + fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.8 + - name: Install Build Tools + run: | + python -m pip install build wheel + - name: Remove alpha (declare stable) + run: | + VER=$(python setup.py --version) + python scripts/remove_alpha.py + - name: "Generate release changelog" + uses: heinrichreimer/github-changelog-generator-action@v2.3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + id: changelog + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Declare alpha stable + branch: dev + - name: Push dev -> master + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: master + force: true + - name: version + run: echo "::set-output name=version::$(python setup.py --version)" + id: version + - name: Create Release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token + with: + tag_name: V${{ steps.version.outputs.version }} + release_name: Release ${{ steps.version.outputs.version }} + body: | + Changes in this Release + ${{ steps.changelog.outputs.changelog }} + draft: false + prerelease: false + commitish: master + - name: Build Distribution Packages + run: | + python setup.py bdist_wheel + - name: Prepare next Minor version + run: echo "::set-output name=version::$(python setup.py --version)" + id: alpha + - name: Increment Version ${{ steps.alpha.outputs.version }}Alpha0 + run: | + VER=$(python setup.py --version) + python scripts/bump_minor.py + - name: Commit to dev + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Prepare Next Version + branch: dev + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{secrets.PYPI_TOKEN}} + - name: Send message to Matrix bots channel + id: matrix-chat-message + uses: fadenb/matrix-chat-message@v0.0.6 + with: + homeserver: 'matrix.org' + token: ${{ secrets.MATRIX_TOKEN }} + channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org' + message: | + New skill-ovos-wordnet release! ${{ steps.version.outputs.version }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c8ece8c --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +dev.env +.dev_opts.json +.idea +*.code-workspace +*.pyc +*.swp +*~ +*.egg-info/ +build +dist +.coverage +/htmlcov +.installed +.mypy_cache +.vscode +.theia +.venv/ + +# Created by unit tests +.pytest_cache/ +/.gtm/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d7f0cf1 --- /dev/null +++ b/LICENSE @@ -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 2021 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..bb58308 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +recursive-include dialog * +recursive-include vocab * +recursive-include locale * +recursive-include res * +recursive-include ui * +recursive-include skill * \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b3f0f1 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Wordnet Skill + +Use Wordnet to answer dictionary like questions + +## About + +Uses [Wordnet](https://wordnet.princeton.edu/) to provide information. + +## Examples + +* "what is the definition of ..." +* "what is the antonym of ..." + +## Category +**Information** + +## Tags +#Wordnet +#query diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..b9a8871 --- /dev/null +++ b/__init__.py @@ -0,0 +1,128 @@ +# 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 random + +from ovos_classifiers.opm.nltk import WordnetSolverPlugin +from ovos_workshop.decorators import intent_handler +from ovos_workshop.skills.common_query_skill import CommonQuerySkill, CQSMatchLevel + + +class WordnetSkill(CommonQuerySkill): + def initialize(self): + self.wordnet = WordnetSolverPlugin() + + # intents + @intent_handler("search_wordnet.intent") + def handle_search(self, message): + query = message.data["query"] + summary = self.wordnet.spoken_answer(query, lang=self.lang) + if summary: + self.speak(summary) + else: + self.speak_dialog("no_answer") + + @intent_handler("definition.intent") + def handle_definition(self, message): + query = message.data["query"] + res = self.wordnet.search(query, lang=self.lang).get("definition") + if res: + self.speak(res) + else: + self.speak_dialog("no_answer") + + # TODO - plural vs singular questions + # TODO - "N lemmas of {query}" + @intent_handler("lemma.intent") + def handle_lemma(self, message): + query = message.data["query"] + res = self.wordnet.search(query, lang=self.lang).get("lemmas") + if res: + self.speak(random.choice(res)) + else: + self.speak_dialog("no_answer") + + @intent_handler("antonym.intent") + def handle_antonym(self, message): + query = message.data["query"] + res = self.wordnet.search(query, lang=self.lang).get("antonyms") + if res: + self.speak(random.choice(res)) + else: + self.speak_dialog("no_answer") + + @intent_handler("holonym.intent") + def handle_holonym(self, message): + query = message.data["query"] + res = self.wordnet.search(query, lang=self.lang).get("holonyms") + if res: + self.speak(random.choice(res)) + else: + self.speak_dialog("no_answer") + + @intent_handler("hyponym.intent") + def handle_hyponym(self, message): + query = message.data["query"] + res = self.wordnet.search(query, lang=self.lang).get("hyponyms") + if res: + self.speak(random.choice(res)) + else: + self.speak_dialog("no_answer") + + @intent_handler("hypernym.intent") + def handle_hypernym(self, message): + query = message.data["query"] + res = self.wordnet.search(query, lang=self.lang).get("hypernyms") + if res: + self.speak(random.choice(res)) + else: + self.speak_dialog("no_answer") + + # common query + def CQS_match_query_phrase(self, phrase): + summary = self.wordnet.spoken_answer(query, lang=self.lang) + if summary: + self.log.info(f"Wordnet answer: {summary}") + return (phrase, CQSMatchLevel.CATEGORY, summary, + {'query': phrase, + 'answer': summary}) + + def CQS_action(self, phrase, data): + pass + + +if __name__ == "__main__": + from ovos_utils.fakebus import FakeBus + + d = WordnetSkill(skill_id="wordnet.ovos", bus=FakeBus()) + + query = "what is the definition of computer" + + ans = d.wordnet.search("computer") + print(ans) + # {'lemmas': ['computer', 'computing machine', 'computing device', 'data processor', 'electronic computer', 'information processing system'], + # 'antonyms': [], + # 'holonyms': [], + # 'hyponyms': ['analog computer', 'digital computer', 'home computer', 'node', 'number cruncher', 'pari-mutuel machine', 'predictor', 'server', 'turing machine', 'web site'], + # 'hypernyms': ['machine'], + # 'root_hypernyms': ['entity'], + # 'definition': 'a machine for performing calculations automatically'} + + # full answer + ans = d.wordnet.spoken_answer(query) + print(ans) + # a machine for performing calculations automatically + + # bidirectional auto translate by passing lang + sentence = d.wordnet.spoken_answer("qual é a definição de computador", lang="pt-pt") + print(sentence) + # uma máquina para realizar cálculos automaticamente diff --git a/locale/en-us/antonym.intent b/locale/en-us/antonym.intent new file mode 100644 index 0000000..f94248d --- /dev/null +++ b/locale/en-us/antonym.intent @@ -0,0 +1,3 @@ +what is a antonym of {query} +what is the antonym of {query} +what are the antonyms of {query} \ No newline at end of file diff --git a/locale/en-us/definition.intent b/locale/en-us/definition.intent new file mode 100644 index 0000000..e933602 --- /dev/null +++ b/locale/en-us/definition.intent @@ -0,0 +1,2 @@ +what is a {query} +what is the definition of {query} \ No newline at end of file diff --git a/locale/en-us/holonym.intent b/locale/en-us/holonym.intent new file mode 100644 index 0000000..a347a66 --- /dev/null +++ b/locale/en-us/holonym.intent @@ -0,0 +1,3 @@ +what is a holonym of {query} +what is the holonym of {query} +what are the holonyms of {query} \ No newline at end of file diff --git a/locale/en-us/hypernym.intent b/locale/en-us/hypernym.intent new file mode 100644 index 0000000..c7a96c2 --- /dev/null +++ b/locale/en-us/hypernym.intent @@ -0,0 +1,3 @@ +what is a hypernym of {query} +what is the hypernym of {query} +what are the hypernyms of {query} \ No newline at end of file diff --git a/locale/en-us/hyponym.intent b/locale/en-us/hyponym.intent new file mode 100644 index 0000000..4d4741b --- /dev/null +++ b/locale/en-us/hyponym.intent @@ -0,0 +1,3 @@ +what is a hyponym of {query} +what is the hyponym of {query} +what are the hyponyms of {query} \ No newline at end of file diff --git a/locale/en-us/lemma.intent b/locale/en-us/lemma.intent new file mode 100644 index 0000000..f8df679 --- /dev/null +++ b/locale/en-us/lemma.intent @@ -0,0 +1,3 @@ +what is a lemma of {query} +what is the lemma of {query} +what are the lemmas of {query} \ No newline at end of file diff --git a/locale/en-us/no_answer.dialog b/locale/en-us/no_answer.dialog new file mode 100644 index 0000000..c3cd456 --- /dev/null +++ b/locale/en-us/no_answer.dialog @@ -0,0 +1 @@ +word net does not know the answer \ No newline at end of file diff --git a/locale/en-us/search_wordnet.intent b/locale/en-us/search_wordnet.intent new file mode 100644 index 0000000..814b278 --- /dev/null +++ b/locale/en-us/search_wordnet.intent @@ -0,0 +1,6 @@ +search wordnet for {query} +search word net for {query} +ask word net about {query} +ask wordnet about {query} +what does wordnet say about {query} +what does word net say about {query} \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..519ae8b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +ovos-utils~=0.0, >=0.0.35 +ovos_workshop~=0.0, >=0.0.11 +ovos-classifiers +ovos-translate-server-plugin +ovos-config~=0.0, >=0.0.11 diff --git a/scripts/bump_alpha.py b/scripts/bump_alpha.py new file mode 100644 index 0000000..e465543 --- /dev/null +++ b/scripts/bump_alpha.py @@ -0,0 +1,18 @@ +import fileinput +from os.path import join, dirname + + +version_file = join(dirname(dirname(__file__)), "version.py") +version_var_name = "VERSION_ALPHA" + +with open(version_file, "r", encoding="utf-8") as v: + for line in v.readlines(): + if line.startswith(version_var_name): + version = int(line.split("=")[-1]) + new_version = int(version) + 1 + +for line in fileinput.input(version_file, inplace=True): + if line.startswith(version_var_name): + print(f"{version_var_name} = {new_version}") + else: + print(line.rstrip('\n')) diff --git a/scripts/bump_build.py b/scripts/bump_build.py new file mode 100644 index 0000000..61099f8 --- /dev/null +++ b/scripts/bump_build.py @@ -0,0 +1,21 @@ +import fileinput +from os.path import join, dirname + + +version_file = join(dirname(dirname(__file__)), "version.py") +version_var_name = "VERSION_BUILD" +alpha_var_name = "VERSION_ALPHA" + +with open(version_file, "r", encoding="utf-8") as v: + for line in v.readlines(): + if line.startswith(version_var_name): + version = int(line.split("=")[-1]) + new_version = int(version) + 1 + +for line in fileinput.input(version_file, inplace=True): + if line.startswith(version_var_name): + print(f"{version_var_name} = {new_version}") + elif line.startswith(alpha_var_name): + print(f"{alpha_var_name} = 0") + else: + print(line.rstrip('\n')) diff --git a/scripts/bump_major.py b/scripts/bump_major.py new file mode 100644 index 0000000..2610fbb --- /dev/null +++ b/scripts/bump_major.py @@ -0,0 +1,27 @@ +import fileinput +from os.path import join, dirname + + +version_file = join(dirname(dirname(__file__)), "version.py") +version_var_name = "VERSION_MAJOR" +minor_var_name = "VERSION_MINOR" +build_var_name = "VERSION_BUILD" +alpha_var_name = "VERSION_ALPHA" + +with open(version_file, "r", encoding="utf-8") as v: + for line in v.readlines(): + if line.startswith(version_var_name): + version = int(line.split("=")[-1]) + new_version = int(version) + 1 + +for line in fileinput.input(version_file, inplace=True): + if line.startswith(version_var_name): + print(f"{version_var_name} = {new_version}") + elif line.startswith(minor_var_name): + print(f"{minor_var_name} = 0") + elif line.startswith(build_var_name): + print(f"{build_var_name} = 0") + elif line.startswith(alpha_var_name): + print(f"{alpha_var_name} = 0") + else: + print(line.rstrip('\n')) diff --git a/scripts/bump_minor.py b/scripts/bump_minor.py new file mode 100644 index 0000000..86dfd9d --- /dev/null +++ b/scripts/bump_minor.py @@ -0,0 +1,24 @@ +import fileinput +from os.path import join, dirname + + +version_file = join(dirname(dirname(__file__)), "version.py") +version_var_name = "VERSION_MINOR" +build_var_name = "VERSION_BUILD" +alpha_var_name = "VERSION_ALPHA" + +with open(version_file, "r", encoding="utf-8") as v: + for line in v.readlines(): + if line.startswith(version_var_name): + version = int(line.split("=")[-1]) + new_version = int(version) + 1 + +for line in fileinput.input(version_file, inplace=True): + if line.startswith(version_var_name): + print(f"{version_var_name} = {new_version}") + elif line.startswith(build_var_name): + print(f"{build_var_name} = 0") + elif line.startswith(alpha_var_name): + print(f"{alpha_var_name} = 0") + else: + print(line.rstrip('\n')) diff --git a/scripts/prepare_skillstore.py b/scripts/prepare_skillstore.py new file mode 100644 index 0000000..5f094bd --- /dev/null +++ b/scripts/prepare_skillstore.py @@ -0,0 +1,76 @@ +from ovos_skills_manager import SkillEntry +from os.path import exists, join, dirname +from shutil import rmtree +import os +from os import makedirs +import json +from ovos_utils.bracket_expansion import expand_parentheses, expand_options + + +branch = "dev" +repo = "skill-ovos-wordnet" +author = "OpenVoiceOS" + +url = f"https://github.com/{author}/{repo}@{branch}" + +skill = SkillEntry.from_github_url(url) +tmp_skills = "/tmp/osm_installed_skills" +skill_folder = f"{tmp_skills}/{skill.uuid}" + +base_dir = dirname(dirname(__file__)) +desktop_dir = join(base_dir, "res", "desktop") +android_ui = join(base_dir, "ui", "+android") +makedirs(desktop_dir, exist_ok=True) + +readme = join(base_dir, "README.md") +jsonf = join(desktop_dir, "skill.json") +desktopf = join(desktop_dir, f"{repo}.desktop") +skill_code = join(base_dir, "__init__.py") + +res_folder = join(base_dir, "locale", "en-us") + + +def read_samples(path): + samples = [] + with open(path) as fi: + for _ in fi.read().split("\n"): + if _ and not _.strip().startswith("#"): + samples += expand_options(_) + return samples + +samples = [] +for root, folders, files in os.walk(res_folder): + for f in files: + if f.endswith(".intent"): + samples += read_samples(join(root, f)) +skill._data["examples"] = list(set(samples)) + +has_android = exists(android_ui) +with open(skill_code) as f: + has_homescreen = f"{repo}.{author}.home" in f.read() + +if not exists(readme): + with open(readme, "w") as f: + f.write(skill.generate_readme()) + +if has_homescreen and not exists(desktopf): + with open(desktopf, "w") as f: + f.write(skill.desktop_file) + +if not exists(jsonf): + data = skill.json + with open(jsonf, "w") as f: + if not has_android or not has_homescreen: + data.pop("android") + if not has_homescreen: + data.pop("desktop") + data["desktopFile"] = False +else: + with open(jsonf) as f: + data = json.load(f) + +# set dev branch +data["branch"] = "dev" + +with open(jsonf, "w") as f: + json.dump(data, f, indent=4) diff --git a/scripts/remove_alpha.py b/scripts/remove_alpha.py new file mode 100644 index 0000000..fca7342 --- /dev/null +++ b/scripts/remove_alpha.py @@ -0,0 +1,13 @@ +import fileinput +from os.path import join, dirname + + +version_file = join(dirname(dirname(__file__)), "version.py") + +alpha_var_name = "VERSION_ALPHA" + +for line in fileinput.input(version_file, inplace=True): + if line.startswith(alpha_var_name): + print(f"{alpha_var_name} = 0") + else: + print(line.rstrip('\n')) diff --git a/scripts/translate.py b/scripts/translate.py new file mode 100644 index 0000000..cb0dd58 --- /dev/null +++ b/scripts/translate.py @@ -0,0 +1,48 @@ +import os +from os.path import dirname, join, exists +from ovos_utils.bracket_expansion import expand_options +from libretranslate_neon_plugin import LibreTranslatePlugin + +tx = LibreTranslatePlugin(config={"libretranslate_host": "https://libretranslate.2022.us"}) + +src_lang = "en-us" +target_langs = ["es-es", "de-de", "fr-fr", "it-it", "pt-pt"] + +exts = [".voc", ".dialog", ".intent", ".entity"] +res_folder = join(dirname(dirname(__file__)), "locale") +target_langs = list(set(target_langs + os.listdir(res_folder))) + +src_files = {} +for root, dirs, files in os.walk(res_folder): + if src_lang not in root: + continue + for f in files: + if any(f.endswith(e) for e in exts): + src_files[f] = join(root, f) + +for lang in target_langs: + os.makedirs(join(res_folder, lang), exist_ok=True) + + for name, src in src_files.items(): + dst = join(res_folder, lang, name) + if exists(dst): + continue + + tx_lines = [] + with open(src) as f: + lines = [l for l in f.read().split("\n") if l and not l.startswith("#")] + + for l in lines: + expanded = expand_options(l) + for l2 in expanded: + try: + translated = tx.translate(l2, target=lang, source=src_lang) + tx_lines.append(translated) + except Exception as e: + print(e) + continue + if tx_lines: + with open(dst, "w") as f: + f.write(f"# auto translated from {src_lang} to {lang}\n") + for translated in set(tx_lines): + f.write(translated + "\n") diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..5052be9 --- /dev/null +++ b/setup.py @@ -0,0 +1,90 @@ +#!/usr/bin/env python3 +import os +from os import walk, path + +from setuptools import setup + +URL = "https://github.com/OpenVoiceOS/skill-ovos-wordnet" +SKILL_CLAZZ = "WordnetSkill" # needs to match __init__.py class name +PYPI_NAME = "skill-wordnet" # 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 get_requirements(requirements_filename: str): + requirements_file = path.join(path.abspath(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("#")] + if 'MYCROFT_LOOSE_REQUIREMENTS' in os.environ: + print('USING LOOSE REQUIREMENTS!') + requirements = [r.replace('==', '>=').replace('~=', '>=') for r in requirements] + return requirements + + +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("README.md", "r") as f: + long_description = f.read() + + +def get_version(): + """ Find the version of this skill""" + version_file = path.join(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(), + description='ovos Wordnet skill plugin', + long_description=long_description, + long_description_content_type="text/markdown", + url=URL, + author='JarbasAi', + 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, + install_requires=get_requirements("requirements.txt"), + keywords='ovos skill plugin', + entry_points={'ovos.plugin.skill': PLUGIN_ENTRY_POINT} +) 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