pyproject.toml

[tool.ruff]

# description of all rules are available on https://docs.astral.sh/ruff/rules/
lint.select = ["D", "E", "F", "W", "C", "S", "I", "G", "TCH", "SLOT", "RUF", "C90", "N", "YTT", "ASYNC", "A", "C4", "T10", "FURB", "PERF", "AIR", "NPY", "FLY", "PLW2901"]

# we need to check 'mood' of all docstrings, this needs to be enabled explicitly
lint.extend-select = ["D401"]

lint.ignore = []

# always generate Python 3.12-compatible code.
target-version = "py312"
lint.pydocstyle.convention = "google"
line-length = 100

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["S101"]
"scripts/*" = ["S101"]

[tool.hatch.version]
path = "ols/version.py"

[tool.hatch.metadata]
allow-direct-references = true

[tool.coverage.run]
source = ["ols", "runner"]
omit = [".venv/*"]

[tool.coverage.report]
# unit tests fails if the total coverage measurement is under this threshold value
fail_under = 90

[tool.mypy]
disable_error_code = ["union-attr", "return-value", "arg-type", "import-untyped"]
ignore_missing_imports = true
plugins = ["pydantic.mypy"]

[tool.pydantic-mypy]
init_forbid_extra = true
init_typed = true
warn_required_dynamic_aliases = true

[tool.bandit]
skips = []
exclude_dirs = ["tests", "scripts"]

[dependency-groups]
dev = [
    "black>=25.1.0",
    "pydocstyle>=6.3.0",
    "mypy>=1.17.0",
    "packaging>=24.1",
    "pytest>=8.3.2",
    "pytest-cov>=5.0.0",
    "pytest-asyncio>=0.24.0",
    "pydantic>=2.9.2",
    "ruff>=0.8.0",
    "bandit>=1.7.9",
    "types-requests>=2.32.0.20240622",
    "gradio>=4.44.1",
    "boto3>=1.34.145",
    "pyroscope-io>=0.8.8",
    "memray>=1.15.0",
    "pytest-benchmark[histogram]>=4.0.0",
    "typing-extensions>=4.12.2",
    "pytest-subtests>=0.13.1",
    "build>=1.2.2.post1",
    "twine>=5.1.1",
    "pylint>=3.3.2",
    "matplotlib>=3.10.0",
    "pybuild-deps>=0.5.0",
]

# The following section is needed only for torch[cpu] variant on Linux,
# because this variant need to be downloaded from external link, not from
# standard Python package index:
#
# [tool.uv.sources]
# torch = { url = "https://download.pytorch.org/whl/cpu/torch_stable.html" }

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

[project]
name = "ols"
dynamic = ["version"]
description = "OpenShift Lightspeed is an AI powered assistant that runs on OpenShift and provides answers to product questions using backend LLM services."
authors = []
# NOTE: langchain bumps causes mypy issues
dependencies = [
    "aiohttp>=3.13.3",
    "aiostream>=0.7.0",
    "httpx>=0.28.0",
    "fastapi>=0.115.6",
    "langchain>=0.3.12",
    "langchain-ibm>=0.3.2",
    "llama-index>=0.12.25",
    "llama-index-core>=0.12.44",
    "llama-index-vector-stores-faiss>=0.3.0",
    "llama-index-embeddings-huggingface>=0.4.0",
    "uvicorn>=0.32.1",
    "faiss-cpu>=1.9.0.post1",
    "openai>=1.54.3",
    "langchain-openai>=0.2.9",
    "langchain-google-genai>=4.0.0",
    "langchain-google-vertexai>=2.1.0",
    "anthropic>=0.40.0", 
    "pydantic>=2.9.2",
    "setuptools>=72.1.0",
    "prometheus-client>=0.20.0",
    # do not upgrade kubernetes to version 34.1.0 before this is resolved
    # https://github.com/kubernetes-client/python/issues/2460
    "kubernetes<34.1.0",
    "psycopg2-binary>=2.9.9",
    "azure-identity>=1.18.0",
    "langchain-community>=0.3.81",
    "sqlalchemy>=2.0.35",
    "ibm-watsonx-ai>=1.3.6",
    "certifi>=2024.8.30",
    "cryptography>=44.0.1",
    "urllib3>=2.6.3",
    "zipp>=3.20.1",
    "jinja2>=3.1.6",
    "starlette>=0.49.1",
    "virtualenv>=20.28.0",
    "requests>=2.32.2",
    "transformers>=4.50.3",
    "langchain-mcp-adapters>=0.2.1",
    "mcp>=1.23.0",
    "qdrant-client>=1.13.3",  # For ToolsRAG vector storage (pure Python, no Rust/Cargo)
    "rank-bm25>=0.2.2",  # For ToolsRAG sparse retrieval
    "python-frontmatter>=1.1.0",  # For parsing skill YAML frontmatter
]
requires-python = ">=3.12,<3.13"
readme = "README.md"
license = {file = "LICENSE"}

[project.urls]
Homepage = "https://github.com/openshift/lightspeed-service"
Issues = "https://github.com/openshift/lightspeed-service/issues"

[project.optional-dependencies]
evaluation = [
    "scikit-learn>=1.6.1",
    "pandas>=2.1.4",
    "rouge-score>=0.1.2",
    "ragas>=0.2.14",
    "datasets>=3.0.0",
    "fastparquet>=2024.11.0",
    "tqdm>=4.67.1",
]
lseval = [
    "lightspeed-evaluation @ git+https://github.com/lightspeed-core/lightspeed-evaluation.git@v0.4.0",
]

[tool.hatch.build.targets.wheel]
packages = ["ols"]

[tool.pylint."MESSAGES CONTROL"]
good-names = ["e"]
disable = ["C0301", "C0302", "E0602", "E0611", "E1101", "R0902", "R0903", "R0913", "R0914", "W0102", "W0212", "W0511", "W0613", "W0621", "W0707", "W0718", "W0719", "R0801", "R0917"]