pyproject.toml

[project]
name = "fish-audio-sdk"
version = "1.3.0"
description = "The official Python library for the Fish Audio API"
authors = [
    {name = "abersheeran", email = "me@abersheeran.com"},
    {name = "James Ding", email = "james@fish.audio"},
]
dependencies = [
    "httpx>=0.27.2",
    "ormsgpack>=1.5.0",
    "pydantic>=2.9.1",
    "httpx-ws>=0.6.2",
    "typing-extensions>=4.15.0",
]
requires-python = ">=3.9"
readme = "README.md"
license = {text = "Apache-2.0"}
keywords = ["fish-audio", "tts", "text-to-speech", "voice-cloning", "ai", "speech-synthesis"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: Apache Software License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Multimedia :: Sound/Audio :: Speech",
    "Topic :: Software Development :: Libraries :: Python Modules",
]

[project.urls]
Homepage = "https://fish.audio"
Documentation = "https://docs.fish.audio"
Repository = "https://github.com/fishaudio/fish-audio-python"
Issues = "https://github.com/fishaudio/fish-audio-python/issues"

[project.optional-dependencies]
utils = [
    "sounddevice>=0.4.6",
    "soundfile>=0.12.1",
]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build.targets.wheel]
packages = ["src/fishaudio", "src/fish_audio_sdk"]

[tool.pytest.ini_options]
asyncio_mode = "auto"

[dependency-groups]
dev = [
    "fish-audio-sdk[utils]",
    "poethepoet>=0.32.0",
    "pydoc-markdown>=4.8.2",
    "pytest>=8.3.5",
    "pytest-asyncio>=0.24.0",
    "pytest-cov>=5.0.0",
    "pytest-rerunfailures>=16.0.1",
    "python-dotenv>=1.0.1",
    "ruff>=0.14.3",
    "ty>=0.0.2",
]

[[tool.pydoc-markdown.loaders]]
type = "python"
packages = ["fishaudio", "fish_audio_sdk"]

[tool.pydoc-markdown.renderer]
type = "mkdocs"
pages = [
    {title = "Fish Audio SDK", name="index", source = "README.md"},
    {title = "Client", name="fishaudio/client", contents = ["fishaudio.client.*"] },
    {title = "Resources", name="fishaudio/resources", contents = ["fishaudio.resources.*"] },
    {title = "Types", name="fishaudio/types", contents = ["fishaudio.types.*"] },
    {title = "Core", name="fishaudio/core", contents = ["fishaudio.core.*"] },
    {title = "Utils", name="fishaudio/utils", contents = ["fishaudio.utils.*"] },
    {title = "Exceptions", name="fishaudio/exceptions", contents = ["fishaudio.exceptions.*"] },
]

[tool.ty.src]
exclude = ["tests/", "examples/"]

[tool.ruff.lint]
extend-select = [
    "F",        # Pyflakes rules
    "W",        # PyCodeStyle warnings
    "E",        # PyCodeStyle errors
    "I",        # Sort imports properly
    "UP",       # Warn if certain things can changed due to newer Python versions
    "C4",       # Catch incorrect use of comprehensions, dict, list, etc
    "FA",       # Enforce from __future__ import annotations
    "ISC",      # Good use of string concatenation
    "ICN",      # Use common import conventions
    "RET",      # Good return practices
    "SIM",      # Common simplification rules
    "TID",      # Some good import practices
    "TC",       # Enforce importing certain types in a TYPE_CHECKING block
    "PTH",      # Use pathlib instead of os.path
    "TD",       # Be diligent with TODO comments
    "NPY",      # Some numpy-specific things
]
ignore = [
    "E501",     # Line too long (handled by ruff format)
]

[tool.ruff.lint.flake8-type-checking]
runtime-evaluated-base-classes = ["pydantic.BaseModel"]

[tool.ruff.lint.pyupgrade]
keep-runtime-typing = true

[tool.poe.tasks]
lint = "ruff check ."
format = "ruff format --check ."
typecheck = "ty check"
check = ["lint", "format", "typecheck"]

lint-fix = "ruff check --fix ."
format-fix = "ruff format ."
fix = ["lint-fix", "format-fix"]

test = "pytest tests/unit/ -v --cov=src/fishaudio --cov-report=xml --cov-report=term"
test-integration = "pytest tests/integration/ -v"

docs = "pydoc-markdown"

[tool.poe.tasks.build]
cmd = "uv build"
executor = {type = "simple"}

[tool.uv.sources]
fish-audio-sdk = { workspace = true }