rename to ovos-adapt to avoid conflicts with original namespace

JarbasAl · JarbasAl · commit bb97ec33c473 · 2024-07-20T17:38:32.000+01:00
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -82,7 +82,7 @@ jobs:
         elif [[ $VERSION == *"-"* ]]; then
           echo "Pre-release suffix detected. Not pushing to mycroft-core."
         else
-          sed -E "s/adapt-parser==[0-9]+\.[0-9]+\.[0-9]+/adapt-parser==$VERSION/" requirements/requirements.txt > tmp-requirements.txt
+          sed -E "s/ovos-adapt-parser==[0-9]+\.[0-9]+\.[0-9]+/ovos-adapt-parser==$VERSION/" requirements/requirements.txt > tmp-requirements.txt
           mv tmp-requirements.txt requirements/requirements.txt
           echo "ADAPT_VERSION=$VERSION" >> $GITHUB_ENV
         fi
@@ -92,9 +92,9 @@ jobs:
       uses: peter-evans/create-pull-request@v3
       with:
         token: ${{ secrets.BOT_TOKEN }}
-        push-to-fork: mycroft-adapt-bot/mycroft-core
+        push-to-fork: mycroft-ovos_adapt-bot/mycroft-core
         commit-message: Update Adapt to v${{ env.ADAPT_VERSION }}
-        branch: feature/update-adapt
+        branch: feature/update-ovos_adapt
         delete-branch: true
         title: Update Adapt to v${{ env.ADAPT_VERSION }}
-        body: Automated update from mycroftai/adapt.
+        body: Automated update from mycroftai/ovos_adapt.
diff --git a/README.md b/README.md
@@ -1,24 +1,10 @@
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) [![CLA](https://img.shields.io/badge/CLA%3F-Required-blue.svg)](https://mycroft.ai/cla) [![Team](https://img.shields.io/badge/Team-Mycroft_Core-violetblue.svg)](https://github.com/MycroftAI/contributors/blob/master/team/Mycroft%20Core.md) ![Status](https://img.shields.io/badge/-Production_ready-green.svg)
-
-[![Build Status](https://travis-ci.org/MycroftAI/adapt.svg?branch=master)](https://travis-ci.org/MycroftAI/adapt) [![Coverage Status](https://coveralls.io/repos/github/MycroftAI/adapt/badge.svg?branch=dev)](https://coveralls.io/github/MycroftAI/adapt?branch=master)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
-[![Join chat](https://img.shields.io/badge/Mattermost-join_chat-brightgreen.svg)](https://chat.mycroft.ai)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) 
 
 Adapt Intent Parser
 ==================
 The Adapt Intent Parser is a flexible and extensible intent definition and determination framework. It is intended to parse natural language text into a structured intent that can then be invoked programatically.
 
-[![Introducing the Adapt Intent Parser](https://mycroft.ai/wp-content/uploads/2019/05/Adapt-video-still.png)](https://www.youtube.com/watch?v=zR9xvPtM6Ro)
-
-Getting Started
-===============
-To take a dependency on Adapt, it's recommended to use virtualenv and pip to install source from github.
-
-```bash
-$ virtualenv myvirtualenv
-$ . myvirtualenv/bin/activate
-$ pip install -e git+https://github.com/mycroftai/adapt#egg=adapt-parser
-```
+This repository contains a OVOS pipeline plugin and bundles a fork of the original [adapt-parser](https://github.com/MycroftAI/adapt) from the defunct MycroftAI
 
 Examples
 ========
@@ -87,26 +73,6 @@ def register_pandora_vocab(emitter):
             register_vocab('Pandora Station', match)
 ```
 
-Development
-===========
-
-Glad you'd like to help!
-
-To install test and development requirements run
-
-```
-pip install -r test-requirements.txt
-```
-
-This will install the test-requirements as well as the runtime requirements for adapt.
-
-To test any changes before submitting them run
-
-```
-./run_tests.sh
-```
-
-This will run the same checks as the Github actions and verify that your code should pass with flying colours.
 
 Reporting Issues
 ================
@@ -115,15 +81,13 @@ please include a serialized copy of the intent determination engine using the de
 utilities.
 
 ```python
-from adapt.engine import IntentDeterminationEngine
+from ovos_adapt.engine import IntentDeterminationEngine
+
 engine = IntentDeterminationEngine()
 # Load engine with vocabulary and parsers
 
-import adapt.tools.debug as atd
-atd.dump(engine, 'debug.adapt')
-```
+import ovos_adapt.tools.debug as atd
 
-Learn More
-========
+atd.dump(engine, 'debug.ovos_adapt')
+```
 
-Further documentation can be found at https://mycroft-ai.gitbook.io/docs/mycroft-technologies/adapt
diff --git a/examples/multi_domain_intent_parser.py b/examples/multi_domain_intent_parser.py
@@ -9,8 +9,8 @@
 
 import json
 import sys
-from adapt.intent import IntentBuilder
-from adapt.engine import DomainIntentDeterminationEngine
+from ovos_adapt.intent import IntentBuilder
+from ovos_adapt.engine import DomainIntentDeterminationEngine
 
 
 engine = DomainIntentDeterminationEngine()
diff --git a/examples/multi_intent_parser.py b/examples/multi_intent_parser.py
@@ -10,8 +10,8 @@
 
 import json
 import sys
-from adapt.intent import IntentBuilder
-from adapt.engine import IntentDeterminationEngine
+from ovos_adapt.intent import IntentBuilder
+from ovos_adapt.engine import IntentDeterminationEngine
 
 engine = IntentDeterminationEngine()
 
diff --git a/examples/regex_intent_parser.py b/examples/regex_intent_parser.py
@@ -9,8 +9,8 @@
 
 import json
 import sys
-from adapt.intent import IntentBuilder
-from adapt.engine import IntentDeterminationEngine
+from ovos_adapt.intent import IntentBuilder
+from ovos_adapt.engine import IntentDeterminationEngine
 
 engine = IntentDeterminationEngine()
 
diff --git a/examples/single_intent_parser.py b/examples/single_intent_parser.py
@@ -7,8 +7,8 @@
 """
 import json
 import sys
-from adapt.intent import IntentBuilder
-from adapt.engine import IntentDeterminationEngine
+from ovos_adapt.intent import IntentBuilder
+from ovos_adapt.engine import IntentDeterminationEngine
 
 engine = IntentDeterminationEngine()
 
diff --git a/ovos_adapt/__init__.py b/ovos_adapt/__init__.py
diff --git a/ovos_adapt/context.py b/ovos_adapt/context.py
diff --git a/ovos_adapt/engine.py b/ovos_adapt/engine.py
@@ -15,10 +15,10 @@
 
 import re
 import heapq
-from adapt.entity_tagger import EntityTagger
-from adapt.parser import Parser
-from adapt.tools.text.tokenizer import EnglishTokenizer
-from adapt.tools.text.trie import Trie
+from ovos_adapt.entity_tagger import EntityTagger
+from ovos_adapt.parser import Parser
+from ovos_adapt.tools.text.tokenizer import EnglishTokenizer
+from ovos_adapt.tools.text.trie import Trie
 
 __author__ = 'seanfitz'
 
diff --git a/ovos_adapt/entity_tagger.py b/ovos_adapt/entity_tagger.py
@@ -13,7 +13,7 @@
 # limitations under the License.
 #
 
-from adapt.tools.text.trie import Trie
+from ovos_adapt.tools.text.trie import Trie
 from six.moves import xrange
 
 __author__ = 'seanfitz'
@@ -32,7 +32,7 @@ def __init__(self, trie, tokenizer, regex_entities=[], max_tokens=20):
 
     def _iterate_subsequences(self, tokens):
         """
-        Using regex invokes this function, which significantly impacts performance of adapt. it is an N! operation.
+        Using regex invokes this function, which significantly impacts performance of ovos_adapt. it is an N! operation.
 
         Args:
             tokens(list): list of tokens for Yield results.
diff --git a/ovos_adapt/expander.py b/ovos_adapt/expander.py
diff --git a/ovos_adapt/intent.py b/ovos_adapt/intent.py
diff --git a/ovos_adapt/parser.py b/ovos_adapt/parser.py
@@ -14,8 +14,8 @@
 #
 
 import time
-from adapt.expander import BronKerboschExpander
-from adapt.tools.text.trie import Trie
+from ovos_adapt.expander import BronKerboschExpander
+from ovos_adapt.tools.text.trie import Trie
 
 __author__ = 'seanfitz'
 
diff --git a/ovos_adapt/tools/__init__.py b/ovos_adapt/tools/__init__.py
diff --git a/ovos_adapt/tools/debug/__init__.py b/ovos_adapt/tools/debug/__init__.py
@@ -1,6 +1,6 @@
 import pickle
 
-from adapt.engine import DomainIntentDeterminationEngine, \
+from ovos_adapt.engine import DomainIntentDeterminationEngine, \
     IntentDeterminationEngine
 
 """
@@ -12,7 +12,7 @@
 First, we expect the deserialized object to be an instance of 
 IntentDeterminationEngine or DomainIntentDeterminationEngine as a basic
 sanity check. We also leverage a custom `pickle.Unpickler` implementation
-that only allows specific imports from the adapt namespace, and displays
+that only allows specific imports from the ovos_adapt namespace, and displays
 a helpful error message if this assumption is validated.
 
 This is a bit of security theater; folks investigating issues have to know to 
@@ -27,12 +27,12 @@
 ])
 
 SAFE_CLASSES = [
-    ("adapt.engine", "IntentDeterminationEngine"),
-    ("adapt.engine", "DomainIntentDeterminationEngine"),
-    ("adapt.tools.text.tokenizer", "EnglishTokenizer"),
-    ("adapt.tools.text.trie", "Trie"),
-    ("adapt.tools.text.trie", "TrieNode"),
-    ("adapt.intent", "Intent")
+    ("ovos_adapt.engine", "IntentDeterminationEngine"),
+    ("ovos_adapt.engine", "DomainIntentDeterminationEngine"),
+    ("ovos_adapt.tools.text.tokenizer", "EnglishTokenizer"),
+    ("ovos_adapt.tools.text.trie", "Trie"),
+    ("ovos_adapt.tools.text.trie", "TrieNode"),
+    ("ovos_adapt.intent", "Intent")
 ]
 
 
@@ -62,7 +62,7 @@ def load(filename):
 
 def dump(engine, filename):
     """
-    Serialize an adapt Intent engine and write it to the target file.
+    Serialize an ovos_adapt Intent engine and write it to the target file.
     :param engine (IntentDeterminationEngine or DomainIntentDeterminationEngine):
     :param filename (str): destination path
     """
diff --git a/ovos_adapt/tools/text/__init__.py b/ovos_adapt/tools/text/__init__.py
diff --git a/ovos_adapt/tools/text/tokenizer.py b/ovos_adapt/tools/text/tokenizer.py
diff --git a/ovos_adapt/tools/text/trie.py b/ovos_adapt/tools/text/trie.py
diff --git a/setup.py b/setup.py
@@ -31,17 +31,16 @@ def required(requirements_file):
                 if pkg.strip() and not pkg.startswith("#")]
 
 setup(
-    name="adapt-parser",
+    name="ovos-adapt-parser",
     version="1.0.0",
     author="Sean Fitzgerald",
-    author_email="sean@fitzgeralds.me",
     description=("A text-to-intent parsing framework."),
     long_description=long_description,
     long_description_content_type="text/markdown",
     license=("Apache License 2.0"),
     keywords="natural language processing",
-    url="https://github.com/MycroftAI/adapt",
-    packages=["adapt", "adapt.tools", "adapt.tools.text", "adapt.tools.debug"],
+    url="https://github.com/OpenVoiceOS/ovos-adapt-pipeline-plugin",
+    packages=["ovos_adapt", "ovos_adapt.tools", "ovos_adapt.tools.text", "ovos_adapt.tools.debug"],
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
diff --git a/test/ContextManagerIntegrationTest.py b/test/ContextManagerIntegrationTest.py
@@ -13,9 +13,9 @@
 # limitations under the License.
 #
 
-from adapt.context import ContextManager
-from adapt.engine import IntentDeterminationEngine
-from adapt.intent import IntentBuilder
+from ovos_adapt.context import ContextManager
+from ovos_adapt.engine import IntentDeterminationEngine
+from ovos_adapt.intent import IntentBuilder
 
 __author__ = "seanfitz"
 
diff --git a/test/ContextManagerTest.py b/test/ContextManagerTest.py
@@ -15,7 +15,7 @@
 
 import unittest
 
-from adapt.context import ContextManager, ContextManagerFrame
+from ovos_adapt.context import ContextManager, ContextManagerFrame
 
 
 class ContextManagerFrameTest(unittest.TestCase):
diff --git a/test/DomainIntentEngineTest.py b/test/DomainIntentEngineTest.py
@@ -14,11 +14,11 @@
 #
 
 import unittest
-from adapt.engine import DomainIntentDeterminationEngine
-from adapt.intent import IntentBuilder
-from adapt.entity_tagger import EntityTagger
-from adapt.tools.text.tokenizer import EnglishTokenizer
-from adapt.tools.text.trie import Trie
+from ovos_adapt.engine import DomainIntentDeterminationEngine
+from ovos_adapt.intent import IntentBuilder
+from ovos_adapt.entity_tagger import EntityTagger
+from ovos_adapt.tools.text.tokenizer import EnglishTokenizer
+from ovos_adapt.tools.text.trie import Trie
 
 __author__ = 'seanfitz'
 
diff --git a/test/EntityExpanderTest.py b/test/EntityExpanderTest.py
@@ -13,10 +13,10 @@
 # limitations under the License.
 #
 
-from adapt.entity_tagger import EntityTagger
-from adapt.expander import BronKerboschExpander
-from adapt.tools.text.tokenizer import EnglishTokenizer
-from adapt.tools.text.trie import Trie
+from ovos_adapt.entity_tagger import EntityTagger
+from ovos_adapt.expander import BronKerboschExpander
+from ovos_adapt.tools.text.tokenizer import EnglishTokenizer
+from ovos_adapt.tools.text.trie import Trie
 
 __author__ = 'seanfitz'
 
diff --git a/test/EntityTaggerTest.py b/test/EntityTaggerTest.py
@@ -14,9 +14,9 @@
 #
 
 import unittest
-from adapt.entity_tagger import EntityTagger
-from adapt.tools.text.tokenizer import EnglishTokenizer
-from adapt.tools.text.trie import Trie
+from ovos_adapt.entity_tagger import EntityTagger
+from ovos_adapt.tools.text.tokenizer import EnglishTokenizer
+from ovos_adapt.tools.text.trie import Trie
 import re
 
 __author__ = 'seanfitz'
diff --git a/test/IntentEngineTest.py b/test/IntentEngineTest.py
@@ -14,8 +14,8 @@
 #
 
 import unittest
-from adapt.engine import IntentDeterminationEngine
-from adapt.intent import IntentBuilder
+from ovos_adapt.engine import IntentDeterminationEngine
+from ovos_adapt.intent import IntentBuilder
 
 __author__ = 'seanfitz'
 
diff --git a/test/IntentTest.py b/test/IntentTest.py
@@ -15,11 +15,11 @@
 
 import re
 import unittest
-from adapt.parser import Parser
-from adapt.entity_tagger import EntityTagger
-from adapt.intent import IntentBuilder, resolve_one_of, choose_1_from_each
-from adapt.tools.text.tokenizer import EnglishTokenizer
-from adapt.tools.text.trie import Trie
+from ovos_adapt.parser import Parser
+from ovos_adapt.entity_tagger import EntityTagger
+from ovos_adapt.intent import IntentBuilder, resolve_one_of, choose_1_from_each
+from ovos_adapt.tools.text.tokenizer import EnglishTokenizer
+from ovos_adapt.tools.text.trie import Trie
 
 __author__ = 'seanfitz'
 
diff --git a/test/TrieTest.py b/test/TrieTest.py
@@ -14,7 +14,7 @@
 #
 
 import unittest
-from adapt.tools.text.trie import Trie
+from ovos_adapt.tools.text.trie import Trie
 
 __author__ = 'seanfitz'
 
