Transition to pyproject.toml

Author: synesthesiam

.github/workflows/test.yml

@@ -17,14 +17,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python_version: ["3.8", "3.9", "3.10", "3.11"]
+        python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v4.1.1
       - uses: actions/setup-python@v5
         with:
           python-version: "${{ matrix.python_version }}"
           cache: "pip"
-          cache-dependency-path: requirements_dev.txt
+          cache-dependency-path: pyproject.toml
       - run: script/setup --dev
       - run: script/lint
       - run: script/test

CHANGELOG.md

@@ -1,7 +1,8 @@
 # Changelog
 
-## 1.7.0
+## 1.6.1
 
+- Migrate to pyproject.toml
 - Add `language` to `transcript`
 
 ## 1.6.0

pyproject.toml

@@ -0,0 +1,64 @@
+[project]
+name = "wyoming"
+version = "1.6.1"
+description = "Peer-to-peer protocol for voice assistants"
+readme = "README.md"
+requires-python = ">=3.8.1,<3.13"
+license = {text = "MIT"}
+authors = [
+    {name = "Michael Hansen", email = "mike@rhasspy.org"}
+]
+keywords = ["voice", "assistant", "protocol"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Text Processing :: Linguistic",
+    "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",
+]
+
+[project.urls]
+Homepage = "http://github.com/OHF-voice/wyoming"
+
+[tool.setuptools.packages.find]
+include = ["wyoming", "wyoming.*"]
+exclude = ["tests", "tests.*"]
+
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_untyped_defs = true
+
+[project.optional-dependencies]
+dev = [
+    "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",
+    "build==1.2.2.post1",
+]
+zeroconf = [
+    "zeroconf==0.88.0"
+]
+http = [
+    "Flask==3.0.2",
+    "swagger-ui-py==23.9.23",
+]

requirements_dev.txt

@@ -9,5 +9,5 @@ _VENV_DIR = _PROGRAM_DIR / ".venv"
 
 context = venv.EnvBuilder().ensure_directories(_VENV_DIR)
 subprocess.check_call(
-    [context.env_exe, _PROGRAM_DIR / "setup.py", "bdist_wheel", "sdist"]
+    [context.env_exe, "-m", "build", "--wheel", "--sdist"]
 )

script/package

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+import argparse
 import subprocess
 import venv
 from pathlib import Path
@@ -7,6 +8,13 @@ _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")
+parser.add_argument("--http", action="store_true", help="Install http requirements")
+parser.add_argument(
+    "--zeroconf", action="store_true", help="Install zeroconf requirements"
+)
+args = parser.parse_args()
 
 # Create virtual environment
 builder = venv.EnvBuilder(with_pip=True)
@@ -19,4 +27,18 @@ 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_dev.txt")])
+extras = []
+if args.dev:
+    extras.append("dev")
+
+if args.http:
+    extras.append("http")
+
+if args.zeroconf:
+    extras.append("zeroconf")
+
+extras_str = ""
+if extras:
+    extras_str = "[" + ",".join(extras) + "]"
+
+subprocess.check_call(pip + ["install", "-e", f"{_PROGRAM_DIR}{extras_str}"])

script/setup

@@ -1,6 +1,7 @@
-"""The Wyoming protocol for Rhasspy."""
+"""Peer-to-peer protocol for voice assistants."""
 from .version import __version__
 
+
 __author__ = "Michael Hansen"
 __email__ = "mike@rhasspy.org"
 

setup.py

@@ -1,18 +1,16 @@
 """HTTP server for intent recognition/handling."""
 
-import io
 import logging
-import wave
 from pathlib import Path
-from typing import Any, Dict, Optional
+from typing import Any, Dict
 
-from flask import Response, request
+from flask import request
 
 from wyoming.asr import Transcript
 from wyoming.client import AsyncClient
 from wyoming.error import Error
-from wyoming.intent import Intent, NotRecognized
 from wyoming.handle import Handled, NotHandled
+from wyoming.intent import Intent, NotRecognized
 
 from .shared import get_app, get_argument_parser
 
@@ -29,7 +27,7 @@ def main():
     app = get_app("intent", CONF_PATH, args)
 
     @app.route("/api/recognize-intent", methods=["POST", "GET"])
-    async def api_stt() -> Response:
+    async def api_stt() -> Dict[str, Any]:
         uri = request.args.get("uri", args.uri)
         if not uri:
             raise ValueError("URI is required")