Move OCP and TTS plugin to extra dependencies

Add `Install` section to documentation
OpenVoiceOS · Oct 26, 2023 · 8222f4b · 8222f4b
1 parent b6e0306
commit 8222f4b
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,14 @@ The "mouth" of the OVOS assistant!
 
 Handles TTS generation and audio playback
 
+## Install
+
+`pip install ovos-audio[extras]` to install this package and the default
+plugins.
+
+Without `extras`, you will also need to manually install,
+and possibly configure TTS and Audio Backend modules as described below.
+
 # Configuration
 
 under mycroft.conf

diff --git a/requirements.txt b/requirements.txt
diff --git a/requirements/extras.txt b/requirements/extras.txt
@@ -0,0 +1,9 @@
+ovos_plugin_common_play~=0.0, >=0.0.6a2
+
+ovos-tts-plugin-server
+
+# ovos-ocp-youtube-plugin
+ovos-ocp-m3u-plugin
+ovos-ocp-rss-plugin
+ovos-ocp-files-plugin
+ovos-ocp-news-plugin
diff --git a/requirements/requirements.txt b/requirements/requirements.txt
@@ -0,0 +1,5 @@
+ovos-utils~=0.0, >=0.0.35
+ovos-bus-client~=0.0, >=0.0.5
+ovos-config~=0.0,>=0.0.10
+ovos-plugin-manager~=0.0, >=0.0.24a12
+
diff --git a/setup.py b/setup.py
@@ -63,7 +63,10 @@ def get_version():
     description="ovos-core audio daemon client",
     include_package_data=True,
     packages=find_packages(include=['ovos*']),
-    install_requires=required("requirements.txt"),
+    install_requires=required('requirements/requirements.txt'),
+    extras_require={
+        "extras": required("requirements/extras.txt")
+    },
     classifiers=[
         "Development Status :: 4 - Beta",
         "Programming Language :: Python :: 3",