2 Commits

Author SHA1 Message Date
d20fb52d4b export app, fastapi entrypoint
patch bump
2026-04-05 01:41:15 +01:00
6ef9be7a61 add healtcheck example 2026-04-05 01:32:29 +01:00
4 changed files with 19 additions and 14 deletions

View File

@@ -14,7 +14,7 @@ pip install vmr-http
## Run
```console
uvicorn vmr_http.app:app
uvicorn vmr_http:app
```
## Use
@@ -66,6 +66,14 @@ curl -X 'GET' \
-H 'accept: application/json'
```
*Healthcheck*
```console
curl -X 'GET' \
'http://127.0.0.1:8000/health' \
-H 'accept: application/json'
```
## Documentation
FastAPI [generates automatic docs][auto-docs], visit the link in the startup message when you launch the server.

View File

@@ -1,15 +1,11 @@
[project]
name = "vmr-http"
version = "0.3.0"
version = "0.3.1"
description = "HTTP API for controlling Voicemeeter"
readme = "README.md"
authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
requires-python = ">=3.10"
dependencies = [
"fastapi>=0.135.3",
"uvicorn>=0.43.0",
"voicemeeter-api>=2.7.2",
]
dependencies = ["fastapi>=0.135.3", "uvicorn>=0.43.0", "voicemeeter-api>=2.7.2"]
classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python",
@@ -26,14 +22,10 @@ requires = ["uv_build>=0.11.3,<0.12.0"]
build-backend = "uv_build"
[dependency-groups]
dev = [
"fastapi[standard]>=0.135.3",
"poethepoet>=0.43.0",
"ruff>=0.15.9",
]
dev = ["fastapi[standard]>=0.135.3", "poethepoet>=0.43.0", "ruff>=0.15.9"]
[tool.fastapi]
entrypoint = "vmr_http.app:app"
entrypoint = "vmr_http:app"
[tool.uv.sources]
voicemeeter-api = { path = "../voicemeeter-api-python", editable = true }

View File

@@ -0,0 +1,5 @@
"""Voicemeeter HTTP API."""
from .app import app
__all__ = ['app']

2
uv.lock generated
View File

@@ -1151,7 +1151,7 @@ wheels = [
[[package]]
name = "vmr-http"
version = "0.3.0"
version = "0.3.1"
source = { editable = "." }
dependencies = [
{ name = "fastapi" },