Feature/v4-sec-provider: Add SEC provider to V4

openbb_platform/dev_install.py

@@ -37,6 +37,7 @@
 openbb-biztoc = { path = "./providers/biztoc", optional = true, develop = true }
 openbb-cboe = { path = "./providers/cboe", optional = true, develop = true }
 openbb-quandl = { path = "./providers/quandl", optional = true, develop = true }
+openbb-sec = { path = "./providers/sec", optional = true, develop = true }
 openbb-yfinance = { path = "./providers/yfinance", optional = true, develop = true }
 
 openbb-charting = { path = "./extensions/charting", optional = true, develop = true }

openbb_platform/extensions/regulators/README.md

@@ -0,0 +1,15 @@
+# OpenBB Regulators Extension
+
+This extension provides a structure for data sourced from various global market regulators.
+
+## Installation
+
+To install the extension, run the following command in this folder:
+
+```bash
+pip install openbb-regulators
+```
+
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+
+Documentation available [here](https://docs.openbb.co/sdk).

openbb_platform/extensions/regulators/integration/test_regulators_api.py

@@ -0,0 +1,131 @@
+import base64
+
+import pytest
+import requests
+from openbb_core.env import Env
+from openbb_provider.utils.helpers import get_querystring
+
+
+@pytest.fixture(scope="session")
+def headers():
+    userpass = f"{Env().API_USERNAME}:{Env().API_PASSWORD}"
+    userpass_bytes = userpass.encode("ascii")
+    base64_bytes = base64.b64encode(userpass_bytes)
+
+    return {"Authorization": f"Basic {base64_bytes.decode('ascii')}"}
+
+
+@pytest.mark.parametrize(
+    "params",
+    [
+        ({"symbol": "TSLA"}),
+        ({"symbol": "SQQQ"}),
+    ],
+)
+@pytest.mark.integration
+def test_regulators_sec_cik_map(params, headers):
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/regulators/sec/cik_map?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200
+
+
+@pytest.mark.parametrize(
+    "params",
+    [
+        ({"query": "berkshire hathaway"}),
+    ],
+)
+@pytest.mark.integration
+def test_regulators_sec_institutions_search(params, headers):
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/regulators/sec/institutions_search?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200
+
+
+@pytest.mark.parametrize(
+    "params",
+    [
+        ({"symbol": "AAPL", "limit": 3, "type": "8-K"}),
+        ({"cik": "0001067983", "limit": 3, "type": "10-Q"}),
+    ],
+)
+@pytest.mark.integration
+def test_regulators_sec_filings(params, headers):
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/regulators/sec/filings?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200
+
+
+@pytest.mark.parametrize(
+    "params",
+    [({"query": "2022"}), ({"url": "https://xbrl.fasb.org/us-gaap/2014/entire/"})],
+)
+@pytest.mark.integration
+def test_regulators_sec_schema_files(params, headers):
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/regulators/sec/schema_files?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200
+
+
+@pytest.mark.parametrize(
+    "params",
+    [
+        ({"query": "0000909832"}),
+        ({"query": "0001067983"}),
+    ],
+)
+@pytest.mark.integration
+def test_regulators_sec_symbol_maps(params, headers):
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/regulators/sec/symbol_map?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200
+
+
+@pytest.mark.parametrize(
+    "params",
+    [({})],
+)
+@pytest.mark.integration
+def test_regulators_sec_rss_litigation(params, headers):
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/regulators/sec/rss_litigation?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200
+
+
+@pytest.mark.parametrize(
+    "params",
+    [({"query": "oil", "use_cache": False})],
+)
+@pytest.mark.integration
+def test_regulators_sec_sic_search(params, headers):
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/regulators/sec/sic_search?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200

openbb_platform/extensions/regulators/integration/test_regulators_python.py

@@ -0,0 +1,96 @@
+"""Test Regulators extension."""
+import pytest
+from openbb_core.app.model.obbject import OBBject
+
+
+@pytest.fixture(scope="session")
+def obb(pytestconfig):
+    """Fixture to setup obb."""
+
+    if pytestconfig.getoption("markexpr") != "not integration":
+        import openbb
+
+        return openbb.obb
+
+
+@pytest.mark.parametrize(
+    "params",
+    [
+        ({"symbol": "TSLA"}),
+        ({"symbol": "SQQQ"}),
+    ],
+)
+@pytest.mark.integration
+def test_regulators_sec_cik_map(params, obb):
+    result = obb.regulators.sec.cik_map(**params)
+    assert result
+    assert isinstance(result, OBBject)
+    assert hasattr(result.results, "cik")
+    assert isinstance(result.results.cik, str)
+
+
+@pytest.mark.parametrize(
+    "params",
+    [
+        ({"symbol": "AAPL", "limit": 3, "type": "8-K"}),
+        ({"cik": "0001067983", "limit": 3, "type": "10-Q"}),
+    ],
+)
+@pytest.mark.integration
+def test_regulators_sec_filings(params, obb):
+    result = obb.regulators.sec.filings(**params)
+    assert result
+    assert isinstance(result, OBBject)
+    assert len(result.results) > 0
+
+
+@pytest.mark.parametrize(
+    "params",
+    [({"query": "2022"}), ({"url": "https://xbrl.fasb.org/us-gaap/2014/entire/"})],
+)
+@pytest.mark.integration
+def test_regulators_sec_schema_files(params, obb):
+    result = obb.regulators.sec.schema_files(**params)
+    assert result
+    assert isinstance(result, OBBject)
+    assert len(result.results.files) > 0
+
+
+@pytest.mark.parametrize(
+    "params",
+    [
+        ({"query": "0000909832"}),
+        ({"query": "0001067983"}),
+    ],
+)
+@pytest.mark.integration
+def test_regulators_sec_symbol_map(params, obb):
+    result = obb.regulators.sec.symbol_map(**params)
+    assert result
+    assert isinstance(result, OBBject)
+    assert hasattr(result.results, "symbol")
+    assert isinstance(result.results.symbol, str)
+
+
+@pytest.mark.parametrize(
+    "params",
+    [({})],
+)
+@pytest.mark.integration
+def test_regulators_sec_rss_litigation(params, obb):
+    result = obb.regulators.sec.rss_litigation(**params)
+    assert result
+    assert isinstance(result, OBBject)
+    assert len(result.results) > 0
+
+
+@pytest.mark.parametrize(
+    "params",
+    [({"query": "oil", "use_cache": False})],
+)
+@pytest.mark.integration
+def test_regulators_sec_sic_search(params, obb):
+    result = obb.regulators.sec.sic_search(**params)
+    assert result
+    assert isinstance(result, OBBject)
+    assert len(result.results) > 0

openbb_platform/extensions/regulators/openbb_regulators/companies_house/companies_house_router.py

@@ -0,0 +1,26 @@
+# pylint: disable=W0613:unused-argument
+# ruff: noqa: F401
+"""Companies House Router."""
+
+from openbb_core.app.model.command_context import CommandContext
+from openbb_core.app.model.obbject import OBBject
+from openbb_core.app.provider_interface import (
+    ExtraParams,
+    ProviderChoices,
+    StandardParams,
+)
+from openbb_core.app.query import Query
+from openbb_core.app.router import Router
+from pydantic import BaseModel
+
+router = Router(prefix="/companies_house")
+
+# @router.command(model="Filings")
+# def filings(
+#    cc: CommandContext,
+#    provider_choices: ProviderChoices,
+#    standard_params: StandardParams,
+#    extra_params: ExtraParams,
+# ) -> OBBject[BaseModel]:
+#    """Look up Companies House filings by ID number."""
+#    return OBBject(results=Query(**locals()).execute())

openbb_platform/extensions/regulators/openbb_regulators/regulators_router.py

@@ -0,0 +1,35 @@
+# pylint: disable=import-outside-toplevel, W0613:unused-argument
+# ruff: noqa: F401
+"""Regulators Router."""
+
+
+from openbb_core.app.model.command_context import CommandContext
+from openbb_core.app.model.obbject import OBBject
+from openbb_core.app.provider_interface import (
+    ExtraParams,
+    ProviderChoices,
+    StandardParams,
+)
+from openbb_core.app.query import Query
+from openbb_core.app.router import Router
+from pydantic import BaseModel
+
+from openbb_regulators.companies_house.companies_house_router import (
+    router as companies_house_router,
+)
+from openbb_regulators.sec.sec_router import router as sec_router
+
+router = Router(prefix="")
+router.include_router(sec_router)
+router.include_router(companies_house_router)
+
+
+# @router.command(model="")
+# def load(
+#    cc: CommandContext,
+#    provider_choices: ProviderChoices,
+#    standard_params: StandardParams,
+#    extra_params: ExtraParams,
+# ) -> OBBject[BaseModel]:
+#    """Stock Historical price. Load stock data for a specific ticker."""
+#    return OBBject(results=Query(**locals()).execute())