mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
dc4b26030f
* refactor openbb-sec for v5 * linting * ty * normalize compare_company_facts * add workflows * python 3.10 fix * add more thorough url validation and tests * ty check * ty for python 3.10 * reconfigure with apps * temp pyproject overrride * pyproject * pyproject * pyproject * codespell * pyproject * fix uk schema file links in schema_files * test coverage * test_cli * port #7547 into this pr * no hard coded prefix * improve filing rendering capabilities * fix xml text detection * make codeql happy * missed a file in the commit * test coverage * codespell * fix flakey test * some updates * management_ownership --> management_profiles * proxy statement markdown * ruff * fix test coverage * more tests * test coverage * fix lint errors * Add SEC adviser search, profile, and universe routes (#7559) * Add SEC institutional data fetchers * Add SEC filing index and Form D routes * Add SEC investment adviser people data * Expose SEC adviser and institutional routes * fix(sec): address adviser review feedback * refactor(sec): narrow adviser support to IAPD search * feat(sec): add adviser firm and individual searches * feat(sec): add adviser profile drill-down * fix: repair pre-commit configuration * feat(sec): add adviser universe route * feat(sec): expose complete Form ADV data --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * fix test coverage --------- Co-authored-by: deeleeramone <> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
131 lines
4.1 KiB
YAML
Vendored
131 lines
4.1 KiB
YAML
Vendored
name: 🧪 test openbb-sec
|
|
|
|
# PR-test for the SEC provider. Triggers when a PR touches any file under
|
|
# ``openbb_platform/providers/sec/`` or this workflow itself.
|
|
#
|
|
# Build-once, test-many: a single ``build`` job produces the wheel + sdist;
|
|
# the ``lint`` and ``test`` jobs install the provider editable from source
|
|
# (``[tool.uv.sources]`` pins openbb-core to the sibling tree, since
|
|
# openbb-core>=2.0.0 is not yet on PyPI) and run across every supported
|
|
# (OS, Python) combination. The unit suite replays entirely from VCR cassettes
|
|
# and mocked transport — no network in CI. The matrix stops at 3.14 because the
|
|
# provider's lxml dependency has no prerelease (3.15) wheels yet.
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [develop, main, v5]
|
|
paths:
|
|
- "openbb_platform/providers/sec/**"
|
|
- ".github/workflows/test-unit-openbb-sec.yml"
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
# Cancel in-flight matrix runs when a new commit lands on the same PR.
|
|
group: test-openbb-sec-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
name: Build sdist + wheel
|
|
runs-on: ubuntu-latest
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
working-directory: openbb_platform/providers/sec
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
|
|
- uses: actions/setup-python@v6
|
|
with:
|
|
python-version: "3.11"
|
|
|
|
- run: python -m pip install --upgrade pip uv
|
|
|
|
- name: Build sdist + wheel
|
|
run: uv build --no-sources
|
|
|
|
- uses: actions/upload-artifact@v4
|
|
with:
|
|
name: openbb-sec-dist
|
|
path: openbb_platform/providers/sec/dist/
|
|
if-no-files-found: error
|
|
retention-days: 7
|
|
|
|
lint:
|
|
name: Lint (ruff + ty)
|
|
needs: build
|
|
runs-on: ubuntu-latest
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
working-directory: openbb_platform/providers/sec
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
|
|
- uses: actions/setup-python@v6
|
|
with:
|
|
python-version: "3.11"
|
|
|
|
- run: python -m pip install --upgrade pip uv
|
|
|
|
- name: Install openbb-sec in editable mode (+ dev group)
|
|
# ``-e .`` reads ``[tool.uv.sources]`` and resolves openbb-core /
|
|
# openbb-devtools from the sibling source trees. ``--group dev``
|
|
# pulls in ruff, ty, pytest, pytest-cov, pytest-recorder, etc.
|
|
run: |
|
|
uv pip install --system -e .
|
|
uv pip install --system --group dev
|
|
|
|
- name: ruff check
|
|
run: ruff check openbb_sec tests integration
|
|
|
|
- name: ruff format --check
|
|
run: ruff format --check openbb_sec tests integration
|
|
|
|
- name: ty check
|
|
run: ty check openbb_sec
|
|
|
|
test:
|
|
name: Test (${{ matrix.os }} / Python ${{ matrix.python_version }})
|
|
needs: build
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
# Linux: full sweep across every released Python.
|
|
- { os: ubuntu-latest, python_version: "3.10" }
|
|
- { os: ubuntu-latest, python_version: "3.11" }
|
|
- { os: ubuntu-latest, python_version: "3.12" }
|
|
- { os: ubuntu-latest, python_version: "3.13" }
|
|
- { os: ubuntu-latest, python_version: "3.14" }
|
|
# macOS + Windows: min and max supported.
|
|
- { os: macos-latest, python_version: "3.10" }
|
|
- { os: macos-latest, python_version: "3.14" }
|
|
- { os: windows-latest, python_version: "3.10" }
|
|
- { os: windows-latest, python_version: "3.14" }
|
|
runs-on: ${{ matrix.os }}
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
working-directory: openbb_platform/providers/sec
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
|
|
- uses: actions/setup-python@v6
|
|
with:
|
|
python-version: ${{ matrix.python_version }}
|
|
allow-prereleases: true
|
|
|
|
- run: python -m pip install --upgrade pip uv
|
|
|
|
- name: Install openbb-sec from source (+ dev group)
|
|
run: |
|
|
uv pip install --system -e .
|
|
uv pip install --system --group dev
|
|
|
|
- name: Run unit tests
|
|
run: pytest tests --cov=openbb_sec --cov-report=term-missing --cov-fail-under=100
|