pyproject.toml

[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "pyonyphe"
# Derived from the Git tag by hatch-vcs: tagging v3.0.1 builds 3.0.1, and
# v3.1.0rc1 builds a real pre-release. Never hardcode it here again.
dynamic = ["version"]
description = "Python client and CLI for the ONYPHE Cyber Defense Search Engine"
readme = "README.md"
requires-python = ">=3.10"
license = "MIT"
license-files = ["LICENSE"]
authors = [{ name = "Sebastien Larinier", email = "slarinier@gmail.com" }]
keywords = ["onyphe", "osint", "cti", "threat-intelligence", "asm", "search-engine"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Information Technology",
    "Topic :: Security",
    "Topic :: Internet",
    "Programming Language :: Python :: 3",
    "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",
    "Typing :: Typed",
]
dependencies = [
    "httpx>=0.28",
    "pydantic>=2.11",
    "python-dotenv>=1.1",
    "tomli>=2.0; python_version < '3.11'",
]

[project.optional-dependencies]
# Only `cli.py` imports typer and rich, so they do not belong to the library.
# Declaring them at runtime imposed rich>=14 on every consumer, which collides
# with pins such as censys==2.0.9 (rich<11) and made pyonyphe unresolvable in
# projects that merely import the client. typer is here too because it pulls
# rich in on its own.
cli = [
    "rich>=14.0",
    "typer>=0.16",
]
# SDK v2: `FastMCP` became `MCPServer` and the import paths moved, so the
# major is pinned rather than left open.
mcp = ["mcp>=2,<3"]

[project.urls]
Homepage = "https://github.com/onyphe/pyonyphe"
Repository = "https://github.com/onyphe/pyonyphe"
Issues = "https://github.com/onyphe/pyonyphe/issues"
Changelog = "https://github.com/onyphe/pyonyphe/blob/master/CHANGELOG.md"

[project.scripts]
pyonyphe = "pyonyphe.cli:main"
pyonyphe-mcp = "pyonyphe.mcp_server:main"

[dependency-groups]
dev = [
    "pytest>=8.3",
    "pytest-asyncio>=0.25",
    "pytest-cov>=6.0",
    "respx>=0.22",
    "ruff>=0.12",
    "ty>=0.0.50",
    "zizmor>=1.28",
    "pre-commit>=4.0",
    "twine>=6.1",
    # The MCP extra, so the server is importable in the test suite.
    "mcp>=2,<3",
    # The CLI extra, so the cli tests still run from a bare dev install.
    "rich>=14.0",
    "typer>=0.16",
    # Not needed at runtime on 3.11+, but ty analyses against 3.10 and has to
    # be able to resolve the fallback import in config.py.
    "tomli>=2.0",
]

[tool.hatch.version]
source = "vcs"

[tool.hatch.build.targets.wheel]
packages = ["src/pyonyphe", "src/onyphe"]

[tool.hatch.build.targets.sdist]
include = ["src", "tests", "docs", "README.md", "LICENSE", "CHANGELOG.md"]

# ---------------------------------------------------------------------------
# ruff — lint + format
# ---------------------------------------------------------------------------
[tool.ruff]
line-length = 100
target-version = "py310"
src = ["src", "tests"]

[tool.ruff.lint]
select = [
    "E",    # pycodestyle errors
    "W",    # pycodestyle warnings
    "F",    # pyflakes
    "I",    # isort
    "N",    # pep8-naming
    "UP",   # pyupgrade
    "B",    # flake8-bugbear
    "C4",   # flake8-comprehensions
    "SIM",  # flake8-simplify
    "TID",  # flake8-tidy-imports
    "PTH",  # flake8-use-pathlib
    "RUF",  # ruff-specific
    "ANN",  # flake8-annotations
    "S",    # flake8-bandit
]
ignore = [
    "ANN401",  # allow typing.Any where the ONYPHE payload is genuinely untyped
    "S101",    # assert is fine in tests
]

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["ANN", "S105", "S106"]

[tool.ruff.lint.isort]
known-first-party = ["pyonyphe"]

# ---------------------------------------------------------------------------
# ty — type checking (Astral)
# ---------------------------------------------------------------------------
[tool.ty.environment]
python-version = "3.10"
python = ".venv"

[tool.ty.src]
include = ["src", "tests"]

[tool.ty.terminal]
error-on-warning = true

# ---------------------------------------------------------------------------
# pytest
# ---------------------------------------------------------------------------
[tool.pytest.ini_options]
minversion = "8.0"
testpaths = ["tests"]
addopts = "--strict-markers --strict-config"
asyncio_mode = "auto"
markers = [
    "integration: hits the real ONYPHE API, needs ONYPHE_API_KEY and burns credits (deselect with -m 'not integration')",
]

[tool.coverage.run]
source = ["src/pyonyphe"]
branch = true

[tool.coverage.report]
exclude_also = [
    "if TYPE_CHECKING:",
    "raise NotImplementedError",
    "@overload",
]