faster into api

ser · ser · commit d2ac64f2ebf1 · 2024-02-24T10:59:58.000+07:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,17 @@
+.DS_Store
+.idea
+*.log
+tmp/
+
+*.py[cod]
+*.egg
+*.egg-info/
+build
+htmlcov
+
+/.venv/
+.mypy_cache/
+__pycache__/
+
+/dist/
+/local/
diff --git a/.isort.cfg b/.isort.cfg
@@ -0,0 +1,6 @@
+[settings]
+multi_line_output=3
+include_trailing_comma=True
+force_grid_wrap=0
+use_parentheses=True
+line_length=88
diff --git a/.projectile b/.projectile
@@ -0,0 +1 @@
+- /.venv/
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Michael Hansen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include requirements.txt
diff --git a/README.md b/README.md
@@ -0,0 +1,40 @@
+# Wyoming Whisper API client
+
+[Wyoming protocol](https://github.com/rhasspy/wyoming) server for the Whisper API speech to text system.
+
+My motivation was to establish a one working STT system for whole household, additionally to Home Assistant
+I use it for Blurt(https://github.com/QuantiusBenignus/blurt#network-transcription)
+gnome shell extension.
+
+You need a running Whisper compatible API service, for example Whisper.cpp instance:
+
+https://github.com/ggerganov/whisper.cpp/tree/master/examples/server
+
+I run it on nvidia GPU with fantastic results with detailed inference on large model in usually about a second:
+
+``` sh
+whisper.cpp/server -m whisper.cpp/models/ggml-large-v3-q5_0.bin --host 0.0.0.0 --port 8910 --print-realtime --print-progress
+```
+
+You need to study whisper.cpp to get more information about running its STT service.
+
+## Local Install
+
+Clone the repository and set up Python virtual environment:
+
+``` sh
+git clone https://github.com/ser/wyoming-whisper-api-client
+cd wyoming-whisper-api-client
+script/setup
+```
+
+Run a server anyone can connect to:
+``` sh
+./script/run --uri tcp://0.0.0.0:7891 --debug --api http://192.168.41.49:8910/inference
+```
+
+# Acknowledgements
+
+1. It's a rewrite of Michael Hansen's wyoming-faster-whisper.
+2. Tests are not functioning as there is no public Whisper API service to test it out.
+
diff --git a/mypy.ini b/mypy.ini
@@ -0,0 +1,5 @@
+[mypy]
+ignore_missing_imports = true
+
+[mypy-setuptools.*]
+ignore_missing_imports = True
diff --git a/pylintrc b/pylintrc
@@ -0,0 +1,40 @@
+[MASTER]
+ignore=faster_whisper
+
+[MESSAGES CONTROL]
+disable=
+  format,
+  abstract-method,
+  cyclic-import,
+  duplicate-code,
+  global-statement,
+  import-outside-toplevel,
+  inconsistent-return-statements,
+  locally-disabled,
+  not-context-manager,
+  too-few-public-methods,
+  too-many-arguments,
+  too-many-branches,
+  too-many-instance-attributes,
+  too-many-lines,
+  too-many-locals,
+  too-many-public-methods,
+  too-many-return-statements,
+  too-many-statements,
+  too-many-boolean-expressions,
+  unnecessary-pass,
+  unused-argument,
+  broad-except,
+  too-many-nested-blocks,
+  invalid-name,
+  unused-import,
+  fixme,
+  useless-super-delegation,
+  missing-module-docstring,
+  missing-class-docstring,
+  missing-function-docstring,
+  import-error,
+  consider-using-with
+
+[FORMAT]
+expected-line-ending-format=LF
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+wyoming
+httpx
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -0,0 +1,7 @@
+black==22.12.0
+flake8==6.0.0
+isort==5.11.3
+mypy==0.991
+pylint==2.15.9
+pytest==7.4.4
+pytest-asyncio==0.23.3
diff --git a/script/format b/script/format
@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+import subprocess
+import venv
+from pathlib import Path
+
+_DIR = Path(__file__).parent
+_PROGRAM_DIR = _DIR.parent
+_VENV_DIR = _PROGRAM_DIR / ".venv"
+_MODULE_DIR = _PROGRAM_DIR / "wyoming_whisper_api_client"
+_TESTS_DIR = _PROGRAM_DIR / "tests"
+
+_FORMAT_DIRS = [_MODULE_DIR, _TESTS_DIR]
+
+context = venv.EnvBuilder().ensure_directories(_VENV_DIR)
+subprocess.check_call([context.env_exe, "-m", "black"] + _FORMAT_DIRS)
+subprocess.check_call([context.env_exe, "-m", "isort"] + _FORMAT_DIRS)
diff --git a/script/lint b/script/lint
@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+import subprocess
+import venv
+from pathlib import Path
+
+_DIR = Path(__file__).parent
+_PROGRAM_DIR = _DIR.parent
+_VENV_DIR = _PROGRAM_DIR / ".venv"
+_MODULE_DIR = _PROGRAM_DIR / "wyoming_whisper_api_client"
+_TESTS_DIR = _PROGRAM_DIR / "tests"
+
+_LINT_DIRS = [_MODULE_DIR, _TESTS_DIR]
+
+context = venv.EnvBuilder().ensure_directories(_VENV_DIR)
+subprocess.check_call([context.env_exe, "-m", "black"] + _LINT_DIRS + ["--check"])
+subprocess.check_call([context.env_exe, "-m", "isort"] + _LINT_DIRS + ["--check"])
+subprocess.check_call([context.env_exe, "-m", "flake8"] + _LINT_DIRS)
+subprocess.check_call([context.env_exe, "-m", "pylint"] + _LINT_DIRS)
+subprocess.check_call([context.env_exe, "-m", "mypy"] + _LINT_DIRS)
diff --git a/script/package b/script/package
@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+import subprocess
+import venv
+from pathlib import Path
+
+_DIR = Path(__file__).parent
+_PROGRAM_DIR = _DIR.parent
+_VENV_DIR = _PROGRAM_DIR / ".venv"
+
+context = venv.EnvBuilder().ensure_directories(_VENV_DIR)
+subprocess.check_call([context.env_exe, _PROGRAM_DIR / "setup.py", "bdist_wheel"])
diff --git a/script/run b/script/run
@@ -0,0 +1,12 @@
+#!/usr/bin/env python3
+import sys
+import subprocess
+import venv
+from pathlib import Path
+
+_DIR = Path(__file__).parent
+_PROGRAM_DIR = _DIR.parent
+_VENV_DIR = _PROGRAM_DIR / ".venv"
+
+context = venv.EnvBuilder().ensure_directories(_VENV_DIR)
+subprocess.check_call([context.env_exe, "-m", "wyoming_whisper_api_client"] + sys.argv[1:])
diff --git a/script/setup b/script/setup
@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+import argparse
+import subprocess
+import venv
+from pathlib import Path
+
+_DIR = Path(__file__).parent
+_PROGRAM_DIR = _DIR.parent
+_VENV_DIR = _PROGRAM_DIR / ".venv"
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--dev", action="store_true", help="Install dev requirements")
+args = parser.parse_args()
+
+# Create virtual environment
+builder = venv.EnvBuilder(with_pip=True)
+context = builder.ensure_directories(_VENV_DIR)
+builder.create(_VENV_DIR)
+
+# Upgrade dependencies
+pip = [context.env_exe, "-m", "pip"]
+subprocess.check_call(pip + ["install", "--upgrade", "pip"])
+subprocess.check_call(pip + ["install", "--upgrade", "setuptools", "wheel"])
+
+# Install requirements
+subprocess.check_call(pip + ["install", "-r", str(_PROGRAM_DIR / "requirements.txt")])
+
+if args.dev:
+    # Install dev requirements
+    subprocess.check_call(
+        pip + ["install", "-r", str(_PROGRAM_DIR / "requirements_dev.txt")]
+    )
diff --git a/script/test b/script/test
@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+import subprocess
+import sys
+import venv
+from pathlib import Path
+
+_DIR = Path(__file__).parent
+_PROGRAM_DIR = _DIR.parent
+_VENV_DIR = _PROGRAM_DIR / ".venv"
+_TEST_DIR = _PROGRAM_DIR / "tests"
+
+context = venv.EnvBuilder().ensure_directories(_VENV_DIR)
+subprocess.check_call([context.env_exe, "-m", "pytest", _TEST_DIR] + sys.argv[1:])
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,22 @@
+[flake8]
+# To work with Black
+max-line-length = 88
+# E501: line too long
+# W503: Line break occurred before a binary operator
+# E203: Whitespace before ':'
+# D202 No blank lines allowed after function docstring
+# W504 line break after binary operator
+ignore =
+    E501,
+    W503,
+    E203,
+    D202,
+    W504
+
+[isort]
+multi_line_output = 3
+include_trailing_comma=True
+force_grid_wrap=0
+use_parentheses=True
+line_length=88
+indent = "    "
diff --git a/setup.py b/setup.py
@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+from pathlib import Path
+
+import setuptools
+from setuptools import setup
+
+this_dir = Path(__file__).parent
+
+requirements = []
+requirements_path = this_dir / "requirements.txt"
+if requirements_path.is_file():
+    with open(requirements_path, "r", encoding="utf-8") as requirements_file:
+        requirements = requirements_file.read().splitlines()
+
+module_name = "wyoming_whisper_api_client"
+module_dir = this_dir / module_name
+data_files = []
+
+version_path = module_dir / "VERSION"
+data_files.append(version_path)
+version = version_path.read_text(encoding="utf-8").strip()
+
+# -----------------------------------------------------------------------------
+
+setup(
+    name=module_name,
+    version=version,
+    description="Wyoming Server for Whisper API client",
+    url="http://github.com/ser/wyoming-whisper-api-client",
+    author="Serge Victor",
+    author_email="wyoming_whisper_api_client@random.re",
+    license="MIT",
+    packages=setuptools.find_packages(),
+    package_data={module_name: [str(p.relative_to(module_dir)) for p in data_files]},
+    install_requires=requirements,
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Text Processing :: Linguistic",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    keywords="rhasspy wyoming whisper stt",
+    entry_points={
+        "console_scripts": ["wyoming-whisper-api-client = wyoming_whisper_api_client.__main__:run"]
+    },
+)
diff --git a/tests/turn_on_the_living_room_lamp.wav b/tests/turn_on_the_living_room_lamp.wav
diff --git a/wyoming_whisper_api_client/VERSION b/wyoming_whisper_api_client/VERSION
@@ -0,0 +1 @@
+1.1.0
diff --git a/wyoming_whisper_api_client/__init__.py b/wyoming_whisper_api_client/__init__.py
@@ -0,0 +1,9 @@
+"""Wyoming server for whisper API client."""
+from pathlib import Path
+
+_DIR = Path(__file__).parent
+_VERSION_PATH = _DIR / "VERSION"
+
+__version__ = _VERSION_PATH.read_text(encoding="utf-8").strip()
+
+__all__ = ["__version__"]
diff --git a/wyoming_whisper_api_client/__main__.py b/wyoming_whisper_api_client/__main__.py
diff --git a/wyoming_whisper_api_client/const.py b/wyoming_whisper_api_client/const.py
diff --git a/wyoming_whisper_api_client/handler.py b/wyoming_whisper_api_client/handler.py
