Files
OpenBB/openbb_platform/providers/sec/pyproject.toml
dlee-bq 7f04334398 - example.py: mark the base Example.scope field frozen so the (#7798)
Literal[api]/Literal[python] subclass overrides are covariant
  read-only narrowings. Subclass fields stay writable at runtime.
- method_definition.py, options_chains.py: pydantic 2.14 types
  FieldInfo.annotation as TypeForm[Any] | None, which ty rejects in
  Union[]/Annotated[] and where  is expected; bind it as Any.
  Use FieldInfo.get_default(call_default_factory=True) instead of
  calling the default_factory union directly.
- economy_views.py: read data/obbject_item without None defaults in the
  IMF shipping views. charting always sets obbject_item, and data is
  only popped when present and not None.- finra, jodi, eia: annotate @asynccontextmanager/@contextmanager
  functions with AsyncGenerator/Generator instead of the deprecated
  AsyncIterator/Iterator return types.
- charting: cast the darts forecast dataset to TimeSeries before
  indexing so .all_values resolves instead of hitting ndarray.
- fred, imf, nasdaq, sec, tmx: turn off invalid-attribute-override and
  invalid-mutable-override for models/** only, following the cboe
  precedent. Provider models extend the standard models by narrowing
  query params to Literals or widening fields to Optional, which these
  rules flag by design.

Co-authored-by: dlee-bq <325002271+dlee-bq@users.noreply.github.com>
2026-10-17 20:50:39 +00:00

115 lines
3.3 KiB
TOML
Vendored

[project]
name = "openbb-sec"
version = "2.0.0"
description = "SEC 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.1",
"openbb-platform-api>=2.0.1",
"fastmcp>=3.2.0",
"diskcache>=5.6.3",
"defusedxml>=0.7.1",
"xmltodict>=0.13.0",
"beautifulsoup4>=4.12",
"lxml>=5.2.1",
]
[project.scripts]
openbb-sec = "openbb_sec.cli:main"
[project.entry-points."openbb_provider_extension"]
sec = "openbb_sec:sec_provider"
[project.entry-points."openbb_core_extension"]
sec = "openbb_sec.sec_router:router"
[project.urls]
Homepage = "https://openbb.co"
Repository = "https://github.com/OpenBB-finance/OpenBB"
[dependency-groups]
dev = ["openbb-devtools>=2.0.1"]
[build-system]
requires = ["hatchling>=1.25"]
build-backend = "hatchling.build"
[tool.hatch.build.targets.wheel]
packages = ["openbb_sec"]
[tool.hatch.build.targets.sdist]
include = [
"openbb_sec",
"README.md",
"pyproject.toml",
]
[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_sec/cli.py" = ["T201", "S404", "S603", "PLC0415"]
"openbb_sec/sec_router.py" = ["ARG001", "PLC0415", "SLF001"]
"openbb_sec/models/*.py" = ["ARG002", "PLC0415", "PLR0911", "PLR0912", "PLR0914", "PLR0915", "PLR0917"]
"openbb_sec/utils/*.py" = ["PLR0911", "PLR0912", "PLR0913", "PLR0914", "PLR0915", "PLR0917", "SLF001", "BLE001"]
"openbb_sec/utils/statement_schema/*.py" = ["PLR0911", "PLR0912", "PLR0913", "PLR0914", "PLR0915", "PLR0917", "SLF001", "BLE001", "B023"]
"tests/**" = ["S101", "S108", "D", "SIM105", "SIM117", "T201", "PLC0415"]
"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_sec"]
exclude = ["tests", "integration"]
[tool.ty.rules]
unresolved-import = "ignore"
[[tool.ty.overrides]]
include = ["openbb_sec/models/**"]
[tool.ty.overrides.rules]
invalid-attribute-override = "ignore"
invalid-mutable-override = "ignore"
[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-q --strict-markers"
markers = [
"record_http: VCR-backed HTTP cassette tests",
"integration: live integration tests against the SEC API",
]
filterwarnings = [
"error",
"ignore::DeprecationWarning:openbb_core.provider.utils.client",
"ignore::pytest.PytestUnraisableExceptionWarning",
"ignore:Using .httpx. with .starlette.testclient. is deprecated",
"ignore:SelectableGroups dict interface is deprecated:DeprecationWarning",
"ignore:The behavior of DataFrame concatenation with empty or all-NA entries is deprecated:FutureWarning",
]