[project]
name = "openbb-cboe"
version = "2.0.0"
description = "Cboe provider extension for OpenBB Platform."
authors = [{ name = "OpenBB Team", email = "hello@openbb.co" }]
license = { text = "Apache-2.0" }
readme = "README.md"
requires-python = ">=3.10,<4"
dependencies = [
    "openbb-core[pandas]>=2.0.0",
    "aiohttp-client-cache>=0.11",
    "aiosqlite>=0.20",
]

[project.optional-dependencies]
charting = ["openbb-charting>=4.0.0"]

[project.entry-points."openbb_provider_extension"]
cboe = "openbb_cboe:cboe_provider"

[project.entry-points."openbb_core_extension"]
cboe = "openbb_cboe.cboe_router:router"

[project.urls]
Homepage = "https://openbb.co"
Repository = "https://github.com/OpenBB-finance/OpenBB"

[dependency-groups]
dev = ["openbb-devtools>=2.0.1", "openbb-charting>=4.0.0", "time-machine>=2.19.0"]

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

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

[tool.ruff]
line-length = 88
target-version = "py310"
fix = true

[tool.ruff.lint]
select = ["D", "E", "W", "F", "S", "UP", "I", "PLC", "PLE", "PLR", "PLW", "SIM", "T20"]
ignore = [
    "PLR2004", "PLR0913", "PLR0915", "PLC0415",
    "E402", "E501",
    "D202", "D203", "D205", "D206", "D210", "D212", "D213", "D214",
    "D215", "D300", "D400", "D404", "D405", "D406", "D407", "D408",
    "D409", "D410", "D411", "D413", "D415", "D416", "D417",
]

[tool.ruff.lint.per-file-ignores]
"openbb_cboe/routers/*.py" = ["ARG001", "PLC0415", "PLR0913", "PLR0917"]
"openbb_cboe/models/*.py" = ["ARG002", "PLC0415", "PLR0912"]
"openbb_cboe/utils/helpers.py" = ["ARG001"]
"openbb_cboe/utils/vix.py" = ["PLR0912", "PLR0914", "PLR0915"]
"openbb_cboe/utils/options/*.py" = ["PLC0415", "PLR0912", "PLR0913", "PLR0914", "PLR0915", "PLR0917", "SLF001"]
"openbb_cboe/views/*.py" = ["PLC0415", "PLR0912"]
"tests/**" = ["S101", "S108", "D", "SIM105", "SIM117"]
"integration/**" = ["S101", "S108", "D", "SIM105", "SIM117", "PLC0415", "ARG001"]
"**/__init__.py" = ["F401"]

[tool.ruff.lint.isort]
combine-as-imports = true
force-wrap-aliases = true

[tool.ruff.lint.pydocstyle]
convention = "numpy"

[tool.ty]
[tool.ty.environment]
python-version = "3.10"

[tool.ty.src]
include = ["openbb_cboe"]
exclude = ["tests", "integration"]

[tool.ty.rules]
unresolved-import = "warn"

# The models extend the platform's standard models by overriding their fields:
# a query parameter narrowed to a ``Literal`` (core derives the parameter's choices
# from it), or a field the provider may leave empty. ty treats both as unsound
# overrides of a mutable attribute. The check is off for the model modules, where
# that is how a provider is written, and stays on everywhere else.
[[tool.ty.overrides]]
include = ["openbb_cboe/models/**"]

[tool.ty.overrides.rules]
invalid-attribute-override = "ignore"
invalid-mutable-override = "ignore"

[tool.coverage.report]
exclude_lines = ["pragma: no cover", "if TYPE_CHECKING:", "raise NotImplementedError", "@overload"]

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-q --strict-markers"
markers = [
    "record_http: VCR-backed HTTP cassette tests",
    "integration: end-to-end tests that hit live services (excluded from the coverage gate)",
]