pyproject.toml

# SPDX-FileCopyrightText: 2026-present UAB ConvertAPI <support@convertapi.com>
#
# SPDX-License-Identifier: Apache-2.0

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

[project]
name = "convertapi-haystack"
dynamic = ["version"]
description = "Haystack converters for ConvertAPI: Office files, HTML and web pages to PDF, and files to Markdown or text Documents"
readme = "README.md"
requires-python = ">=3.11"
license = "Apache-2.0"
license-files = ["LICENSE"]
keywords = ["haystack", "convertapi", "converter", "pdf", "markdown", "office", "ocr", "document-conversion", "rag"]
authors = [{ name = "ConvertAPI", email = "support@convertapi.com" }]
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Developers",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Programming Language :: Python :: 3.15",
  "Programming Language :: Python :: Implementation :: CPython",
  "Topic :: Text Processing",
]
dependencies = ["haystack-ai>=2.23.0", "httpx>=0.27.0"]

[project.urls]
Homepage = "https://www.convertapi.com"
Documentation = "https://github.com/ConvertAPI/convertapi-haystack#readme"
Issues = "https://github.com/ConvertAPI/convertapi-haystack/issues"
Source = "https://github.com/ConvertAPI/convertapi-haystack"

[tool.hatch.version]
source = "vcs"
tag-pattern = "v(?P<version>.*)"

[tool.hatch.version.raw-options]
git_describe_command = 'git describe --tags --match="v[0-9]*"'

[tool.hatch.build.targets.sdist]
exclude = ["/.github", "/listing", "/scripts"]

[tool.hatch.build.targets.wheel]
packages = ["src/haystack_integrations"]

[tool.hatch.envs.default]
installer = "uv"
dependencies = ["ruff"]

[tool.hatch.envs.default.scripts]
fmt = "ruff check --fix {args:.} && ruff format {args:.}"
fmt-check = "ruff check {args:.} && ruff format --check {args:.}"

[tool.hatch.envs.test]
dependencies = ["pytest", "pytest-asyncio", "pytest-cov", "mypy"]

[tool.hatch.envs.test.scripts]
unit = 'pytest -m "not integration" {args:tests}'
integration = 'pytest -m "integration" {args:tests}'
all = "pytest {args:tests}"
cov = "pytest --cov=haystack_integrations {args:tests}"
types = "mypy -p haystack_integrations.components.converters.convertapi {args}"

[tool.ruff]
line-length = 120

[tool.ruff.lint]
select = [
  "A",
  "ANN",
  "ARG",
  "B",
  "C",
  "D102",   # Missing docstring in public method
  "D103",   # Missing docstring in public function
  "D205",   # 1 blank line required between summary line and description
  "D209",   # Closing triple quotes go to new line
  "D213",   # summary lines must be positioned on the second physical line of the docstring
  "D417",   # Missing argument descriptions in the docstring
  "D419",   # Docstring is empty
  "DTZ",
  "E",
  "EM",
  "F",
  "I",
  "ICN",
  "ISC",
  "N",
  "PLC",
  "PLE",
  "PLR",
  "PLW",
  "Q",
  "RUF",
  "S",
  "T",
  "TID",
  "UP",
  "W",
  "YTT",
]
ignore = [
  "B008",    # function call in argument defaults (Secret.from_env_var, as in Haystack)
  "B027",    # empty method in abstract base class
  "S105",    # possible hardcoded password
  "S106",    # possible hardcoded password
  "S107",    # possible hardcoded password
  "C901",    # too complex
  "PLR0911", # too many return statements
  "PLR0912", # too many branches
  "PLR0913", # too many arguments
  "PLR0915", # too many statements
  "PLR0917", # too many positional arguments
  "ANN401",  # Any is used for metadata values
]

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

[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "parents"

[tool.ruff.lint.per-file-ignores]
# Tests can use magic values, assertions and relative imports, and don't need docstrings or annotations
"tests/**/*" = ["D", "PLR2004", "S101", "TID252", "ANN"]
# Examples and scripts print their output and don't need annotations
"examples/**/*" = ["D", "T201", "ANN"]
"scripts/**/*" = ["D", "T201", "ANN", "INP001"]

[tool.mypy]
install_types = true
non_interactive = true
check_untyped_defs = true
disallow_incomplete_defs = true

[tool.coverage.run]
source = ["haystack_integrations"]
branch = true
parallel = false
relative_files = true

[tool.coverage.report]
omit = ["*/tests/*", "*/__init__.py"]
show_missing = true
exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]

[tool.pytest.ini_options]
addopts = ["--strict-markers", "--import-mode=importlib"]
markers = ["integration: tests that call the live ConvertAPI service (need CONVERTAPI_TOKEN)"]
asyncio_default_fixture_loop_scope = "function"