From 8222f4b6d0ca7f9619a463d1ae056081b0e96c23 Mon Sep 17 00:00:00 2001 From: Daniel McKnight Date: Thu, 26 Oct 2023 11:07:38 -0700 Subject: [PATCH] Move OCP and TTS plugin to extra dependencies Add `Install` section to documentation --- README.md | 8 ++++++++ requirements.txt | 14 -------------- requirements/extras.txt | 9 +++++++++ requirements/requirements.txt | 5 +++++ setup.py | 5 ++++- 5 files changed, 26 insertions(+), 15 deletions(-) delete mode 100644 requirements.txt create mode 100644 requirements/extras.txt create mode 100644 requirements/requirements.txt diff --git a/README.md b/README.md index 0109268..09e2120 100644 --- 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 deleted file mode 100644 index e8760ba..0000000 --- a/requirements.txt +++ /dev/null @@ -1,14 +0,0 @@ -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 - -ovos_plugin_common_play~=0.0, >=0.0.6a2 - -ovos-tts-plugin-mimic3-server - -# ovos-ocp-youtube-plugin -ovos-ocp-m3u-plugin -ovos-ocp-rss-plugin -ovos-ocp-files-plugin -ovos-ocp-news-plugin \ No newline at end of file diff --git a/requirements/extras.txt b/requirements/extras.txt new file mode 100644 index 0000000..bf7cc77 --- /dev/null +++ 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 \ No newline at end of file diff --git a/requirements/requirements.txt b/requirements/requirements.txt new file mode 100644 index 0000000..25445e1 --- /dev/null +++ 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 index 21763ea..f5c1646 100644 --- 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",