openbb-platform-api 1.3.5__tar.gz → 2.0.0__tar.gz

openbb_platform_api-2.0.0/.gitignore

@@ -0,0 +1,65 @@
+# General
+__pycache__/
+*.pyc
+.DS_Store
+*.env
+.venv
+venv*/
+venv
+.vscode
+*.ipynb
+env/
+venv/
+!notebooks/jupyter/.gitkeep
+.python-version
+.mypy_cache
+.ruff_cache
+.pytest_cache
+iframe_figures/
+exports/*
+.idea
+.coverage
+.scannerwork
+htmlcov
+**/.ipynb_checkpoints
+*.swp
+*.http
+.coverage.*
+*_tests.csv
+*_sdk_audit.csv
+!build/docker/compose.env
+.dccache
+*rome.json
+**/node_modules/*
+.cursorignore
+darts_logs/
+custom_imports/*.csv
+custom_imports/*/*.csv
+cache/
+lightning_logs/
+*/mocked_path
+*.pem
+
+# CLI
+*.pyo
+**/dist/*
+build/cli
+build/nsis/app
+DMG/*
+*.dmg
+*.sh
+cli/openbb_cli/assets/styles/user/*
+
+# Platform
+openbb_platform/core/openbb/package/*
+openbb_platform/core/openbb/.build.lock
+**/assets/*.json.xz
+
+# Dev Container env
+obb/*
+
+# OpenBB Distribution
+!build/conda/installer/*.sh
+*.pkg
+*.exe
+build/conda/tmp

openbb_platform_api-1.3.5/README.md → openbb_platform_api-2.0.0/PKG-INFO

@@ -1,53 +1,119 @@
-# OpenBB Platform API Launcher
+Metadata-Version: 2.5
+Name: openbb-platform-api
+Version: 2.0.0
+Summary: OpenBB Platform API: launcher and widgets builder for the Open Data Platform REST API and OpenBB Workspace custom-backend connector.
+Project-URL: Homepage, https://openbb.co
+Project-URL: Repository, https://github.com/OpenBB-finance/OpenBB
+Project-URL: Documentation, https://docs.openbb.co/odp/python/extensions/interface/openbb-api
+Author-email: OpenBB Team <hello@openbb.co>
+License: Apache-2.0
+Requires-Python: <4,>=3.10
+Requires-Dist: deepdiff>=8.6.2
+Requires-Dist: openbb-core>=2.0.0
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Description-Content-Type: text/markdown
 
-This package is responsible for launching and configuring an OpenBB Platform environment, or FastAPI instance, to use as an OpenBB Workspace [custom backend](https://docs.openbb.co/workspace/data-integration).
+# OpenBB Platform API
 
-## Installation
+Launcher and widgets builder for the OpenBB Workspace [custom backend](https://docs.openbb.co/workspace/data-integration). Wraps any FastAPI application with the metadata, exception handling, and `widgets.json` generation that OpenBB Workspace expects — so a regular FastAPI app becomes a Workspace data source with no glue code.
 
-This package is included when you run [`pip install openbb`](https://docs.openbb.co/platform/installation); however, it also works as a standalone package
-for creating new backends that are not part of the OpenBB GitHub [repository](https://github.com/OpenBB-finance/OpenBB/).
+> **Full documentation:** [docs.openbb.co/odp/python/extensions/interface/openbb-api](https://docs.openbb.co/odp/python/extensions/interface/openbb-api)
 
-To install as a standalone, use a Python environment between versions 3.9 and 3.12, inclusively.
+## Install
 
 ```sh
 pip install openbb-platform-api
 ```
 
-## Usage
-
-See the [keyword arguments](#keyword-arguments) section for parameters and descriptions.
+Python ≥ 3.10. Already included when you install [`openbb`](https://docs.openbb.co/platform/installation).
 
 ### Launch OpenBB Platform
 
 To start the OpenBB Platform API, open a terminal, activate the environment where it is installed, and then enter:
 
-```
+```sh
 openbb-api
-```
 
-This will launch a Fast API instance, via `uvicorn`, at `http://127.0.0.1:6900`
+# Launch your own FastAPI app
+openbb-api --app /path/to/your_app.py
 
-Uvicorn can be configured by adding keyword arguments, see the section [below](#keyword-arguments)
+# Factory function?
+openbb-api --app some_file.py:create_app --factory
 
-### Launch Custom App
+# Launch as a proxy from an openbb-cli .spec file
+openbb-api --spec /path/to/cli.spec
+```
+
+`widgets.json` is auto-generated from your routes' types, response models, and docstrings. Plotly returns become chart widgets, `BaseModel` returns become tables, scalars become metrics — no manual wiring.
 
-To run your application as an OpenBB Workspace custom backend, add the path to the Python file with the FastAPI instance to the launch command.
+## Spec-driven proxy mode
+
+Generate a spec file with `openbb-cli` against any OpenBB Platform deployment, then launch a Workspace-compatible backend that proxies every command to that upstream:
 
 ```sh
-openbb-api --app /Users/some_user/path/to/main.py
+# Generate the spec once
+openbb --generate-spec --server https://api.example.com -o cli.spec
+
+# Launch the proxy
+openbb-api --spec cli.spec
 ```
 
-#### Arbitrary Instance Name
+Each command in the spec becomes a FastAPI route at its `url_path`; the launcher forwards every request to the spec's `base_url` (preserving query, body, and non-hop-by-hop headers). `widgets.json` is generated from the spec's parameter and response-schema metadata via the same builder used for in-process apps.
 
-Define the FastAPI instance as an arbitrary name with the `--name` argument.
+Useful for shipping a thin frontend container that talks to a managed backend in another cluster, without bundling `openbb-core` or any provider extensions. `--spec` is mutually exclusive with `--app`.
 
-```sh
-openbb-api --app some_file.py --name my_app
+### `[spec]` config — credentials and base-URL override
+
+A `[spec]` table in `openbb.toml` carries the path plus the bits the file alone can't provide — `base_url` overrides for staging/prod, and `headers` injected on every upstream request.
+Header values support the same `$VAR` substitution as `[env]`, so credentials live in environment variables (or `[env]` entries that read from them) and the TOML just maps them onto upstream header names:
+
+```toml
+[env]
+OPENBB_UPSTREAM_TOKEN = "$GITHUB_TOKEN"   # or any orchestrator-injected secret
+
+[spec]
+path     = "/etc/openbb/cli.spec"
+base_url = "https://prod.example.com"     # optional; overrides spec's recorded value
+
+[spec.headers]
+Authorization = "Bearer $OPENBB_UPSTREAM_TOKEN"
+X-Tenant      = "production"
+```
+
+Config-supplied headers OVERRIDE matching incoming-request headers — `[spec.headers]` is the credential-injection point, so a misbehaving client can't leak its own auth value upstream by sending the same header name.
+
+## Custom HTTP middleware (`[middleware]`)
+
+Attach Starlette-style HTTP middleware functions from a config-supplied entrypoint — useful for auth, request logging, tracing, IP allow-listing, response transformation. Each entry is a `"module:async_callable"` reference resolved through the standard import system:
+
+```toml
+[middleware]
+hooks = [
+    "my_pkg.middleware:auth_middleware",
+    "my_pkg.middleware:request_logger",
+]
+```
+
+```python
+# my_pkg/middleware.py
+from fastapi.responses import JSONResponse
+
+async def auth_middleware(request, call_next):
+    if request.headers.get("X-API-Key") != "expected":
+        return JSONResponse({"error": "unauthorized"}, status_code=401)
+    return await call_next(request)
+
+async def request_logger(request, call_next):
+    response = await call_next(request)
+    print(f"{request.method} {request.url.path} → {response.status_code}")
+    return response
 ```
 
-#### Factory Flag
+List order is **outermost-to-innermost**: the first entry sees the request first on the way in and the response last on the way out. Misconfigured references (missing module, wrong attribute, sync function, wrong arity) raise loudly at startup so deployments fail fast instead of silently passing requests through unauthenticated.
 
-If the FastAPI instance is served via a factory function, set the `--factory` flag.
+## Single-file launch
+
+Everything in this README — app source (`--app` or `--spec`), env injection, host/port, SSL, agents, middleware, credentials — can be set in one `openbb.toml` and launched without any other CLI flags:
 
 ```sh
 openbb-api --app some_file.py:main --factory
@@ -59,38 +125,41 @@ The behavior of the script can be configured with the use of arguments and keywo
 
 Launcher specific arguments:
 
-    --app                           Absolute path to the Python file with the target FastAPI instance. Default is the installed OpenBB Platform API.
-    --name                          Name of the FastAPI instance in the app file. Default is 'app'.
-    --factory                       Flag to indicate if the app name is a factory function. Default is 'false'.
-    --editable                      Flag to make widgets.json an editable file that can be modified during runtime. Default is 'false'.
-    --build                         If the file already exists, changes prompt action to overwrite/append/ignore. Only valid when --editable true.
-    --no-build                      Do not build the widgets.json file. Use this flag to load an existing widgets.json file without checking for updates.
-    --exclude                       JSON encoded list of API paths to exclude from widgets.json. Disable entire routes with '*' - e.g. '["/api/v1/*"]'.
-    --no-filter                     Do not filter out widgets in widget_settings.json file.
-    --widgets-json                  Absolute/relative path to use as the widgets.json file. Default is ~/envs/{env}/assets/widgets.json, when --editable is 'true'.
-    --apps-json                     Absolute/relative path to use as the apps.json file. Default is ~/OpenBBUserData/workspace_apps.json.
-    --agents-json                   Absolute/relative path to use as the agents.json file. Including this will add the /agents endpoint to the API.
-
+```text
+--app                           Absolute path to the Python file with the target FastAPI instance. Default is the installed OpenBB Platform API.
+--name                          Name of the FastAPI instance in the app file. Default is 'app'.
+--factory                       Flag to indicate if the app name is a factory function. Default is 'false'.
+--editable                      Flag to make widgets.json an editable file that can be modified during runtime. Default is 'false'.
+--build                         If the file already exists, changes prompt action to overwrite/append/ignore. Only valid when --editable true.
+--no-build                      Do not build the widgets.json file. Use this flag to load an existing widgets.json file without checking for updates.
+--exclude                       JSON encoded list of API paths to exclude from widgets.json. Disable entire routes with '*' - e.g. '["/api/v1/*"]'.
+--no-filter                     Do not filter out widgets in widget_settings.json file.
+--widgets-json                  Absolute/relative path to use as the widgets.json file. Default is ~/envs/{env}/assets/widgets.json, when --editable is 'true'.
+--apps-json                     Absolute/relative path to use as the apps.json file. Default is ~/OpenBBUserData/workspace_apps.json.
+--agents-json                   Absolute/relative path to use as the agents.json file. Including this will add the /agents endpoint to the API.
+```
 
 All other arguments will be passed to uvicorn. Here are the most common ones:
 
-    --host TEXT                     Host IP address or hostname.
-                                      [default: 127.0.0.1]
-    --port INTEGER                  Port number.
-                                      [default: 6900]
-    --ssl_keyfile TEXT              SSL key file.
-    --ssl_certfile TEXT             SSL certificate file.
-    --ssl_keyfile_password TEXT     SSL keyfile password.
-    --ssl_version INTEGER           SSL version to use.
-                                      (see stdlib ssl module's)
-                                      [default: 17]
-    --ssl_cert_reqs INTEGER         Whether client certificate is required.
-                                      (see stdlib ssl module's)
-                                      [default: 0]
-    --ssl_ca_certs TEXT             CA certificates file.
-    --ssl_ciphers TEXT              Ciphers to use.
-                                      (see stdlib ssl module's)
-                                      [default: TLSv1]
+```text
+--host TEXT                     Host IP address or hostname.
+                                  [default: 127.0.0.1]
+--port INTEGER                  Port number.
+                                  [default: 6900]
+--ssl_keyfile TEXT              SSL key file.
+--ssl_certfile TEXT             SSL certificate file.
+--ssl_keyfile_password TEXT     SSL keyfile password.
+--ssl_version INTEGER           SSL version to use.
+                                  (see stdlib ssl module's)
+                                  [default: 17]
+--ssl_cert_reqs INTEGER         Whether client certificate is required.
+                                  (see stdlib ssl module's)
+                                  [default: 0]
+--ssl_ca_certs TEXT             CA certificates file.
+--ssl_ciphers TEXT              Ciphers to use.
+                                  (see stdlib ssl module's)
+                                  [default: TLSv1]
+```
 
 Run `uvicorn --help` to get the full list of arguments.
 
@@ -121,231 +190,69 @@ Contact the system administrator if you are using a work device and require addi
 
 ![This Connection Is Not Private](https://in.norton.com/content/dam/blogs/images/norton/am/this_connection_not_is_private.png)
 
-
 ## Example Application
 
 Examples below will assume this code block is at the start of the file.
 
 ```python
 from fastapi import FastAPI
+from openbb_platform_api.response_models import (
+    Data,
+    MetricResponseModel,
+    OmniWidgetResponseModel,
+    PdfResponseModel,
+)
 
 app = FastAPI()
-```
-
-### Markdown Widget
-
-This script will create a "markdown" widget with the returned text.
 
-```python
+# Markdown — return a string
 @app.get("/hello")
 async def hello() -> str:
-    """Widget Description Generated By Docstring"""
-    return "Hello, from OpenBB!"
-```
-
-### Table Widget
-
-Create a table widget by returning data shaped as a list of dictionaries (records)
-
-```python
-@app.get("/hello")
-async def hello() -> list:
-    """Widget Description Generated By Docstring"""
-    return [{"Column 1": "Hello", "Column 2": "from OpenBB!"}]
-```
-
-### Metric Widget
-
-This widget displays a label, value, and optional delta.
-
-To create a metric widget, import the custom response model below and define it as a return type.
-
-```python
-from openbb_platform_api.response_models import MetricResponseModel
-
-@app.get("/hello_metric")
-async def hello_metric() -> MetricResponseModel:
-    """Widget description created by docstring."""
-    return MetricResponseModel(label="Good Vibes Score", value=100, delta="1%")
-```
-
-This type of widget can be created as an array of MetricResponseModels. Adjust the response to be a `list[MetricRespnoseModel]`
-
-### Query Parameters
-
-Function arguments will populate as widget parameters.
-
-```python
-from typing import Literal, Optional
-
-@app.get("/hello")
-async def hello(param1: Optional[str] = None, param2: Literal["Choice 1", "Choice 2"] = None, param3: bool = False) -> str:
-    """Widget Description Generated By Docstring"""
-    if not param1 and not param2 and not param3:
-        return "Enter a parameter or make a choice!"
-    if param3:
-        return f"Param3 enabled!"
-    if param2:
-        return f"You selected: {param2}"
-    if param1:
-        return f"You entered: {param1}"
-
-    return "Nothing to return!"
-```
-
-### Easy Date Picker
-
-Name the parameter "date", or include "_date" in the name, and type it as a string.
-
-Additionally, a parameter type of `datetime.date` will work.
-
-```python
-import datetime
-
-@app.get("/hello_date")
-async def hello_date(date: str) -> list:
-    """Widget description created by docstring."""
-    # Workspace returns the date as YYYY-MM-DD
-    return [{"Hello": "Row 1!"}, {"Hello": "Row 2!"}]
-
-
-@app.get("/hello_date_range")
-async def hello_date_range(start: datetime.date, end: datetime.date) -> list:
-    """Widget description created by docstring."""
-    # Workspace returns the date as YYYY-MM-DD
-    return [{"Hello": "Row 1!"}, {"Hello": "Row 2!"}]
-```
-
-This demonstrates how to define any of the basic widget parameter types, in a no-frills way. If you just need something that works, it's an easy starting point.
-
-```python
-@app.get("/hello_params")
-async def hello_params(
-    required_param: datetime.date,
-    param_1: str = "Default",
-    param_2: int = 0,
-    param_3: float = None,
-    param_4: Literal["Choice 1", "Choice 2", "Choice 3"] = "Choice 1",
-    param_5: bool = True,
-) -> list:
-    """Widget description created by docstring."""
-    # Handle the "choices" parameter inside the function to convert the displayed label to the desired one.
-    choices_dict = {"Choice 1": "do_one", "Choice 2": "do_two", "Choice 3": "do_three"}
-    choice = choices_dict.get(param_4, None)
-
-    # Do something with the parameters and return the result of work.
-    return [{"Hello": "Row 1!"}, {"Hello": "Row 2!"}]
-```
-
-### Annotated Query Params
-
-Adding helpful placeholder text and tooltips to parameters requires annotating them. This will also help code editors and improve the API documentation.
-
-Additional settings, compatible with `widgets.json`, are defined in the `json_schema_extra` dictionary, under a key, `x-widget_config`
-
-```python
-from typing import Annotated
-from fastapi import Query
-```
-
-The pattern for annotating a query parameter is:
-
-```python
-my_param: Annotated[str, Query(title="My Title", description="My custom hovertext with detailed information")] = None
-```
-
-```python
-@app.get("/hello_annotated_params")
-async def hello_annotated_params(
-    required_param: Annotated[
-        datetime.date, Query(description="The date is required.", title="Required Date")
-    ],
-    not_required_param: Annotated[
-        Literal["Choice 1", "Choice 2", "Choice 3"],
-        Query(
-            description="Choose from a list of possible choices. The default is, 'Choice 1'",
-            title="Selector",
-            json_schema_extra={"x-widget_config": {"multiSelect": True}}  # This lets you select multiple items from dropdown choices.
-        ),
-    ] = "Choice 1",
-) -> list:
-    """Widget description created by docstring."""
-
-    # Do something with the parameters and return the result of work.
-    return [{"Hello": "Row 1!"}, {"Hello": "Row 2!"}]
+    """Tooltip from the docstring."""
+    return "Hello, OpenBB!"
+
+# Table — return a list of records or a typed Data subclass
+@app.get("/rows")
+async def rows() -> list[dict]:
+    return [{"symbol": "AAPL", "price": 150.0}]
+
+# Metric — single label/value/delta
+@app.get("/score")
+async def score() -> MetricResponseModel:
+    return MetricResponseModel(label="Score", value=100, delta="1%")
+
+# Chart — return a Plotly figure JSON
+@app.get("/chart", openapi_extra={"widget_config": {"type": "chart"}})
+async def chart() -> dict:
+    from plotly.graph_objs import Bar, Figure
+    return Figure(data=[Bar(x=["A"], y=[1])]).to_plotly_json()
 ```
 
-### Annotated Table Fields
-
-The procedure for annotating the output is similar to the query parameters, and involves defining a response model.
-
-A response model is a Data model of Fields. Create one by defining a new class that inherits from "Data", and then define each column as a "Field".
+Annotated `Data` models drive auto-generated table column definitions:
 
 ```python
+from datetime import date
 from openbb_platform_api.response_models import Data
 from pydantic import Field
-```
 
-Optional values should be defined, as `Optional[{type}]`, with a default value of `None`.
-
-```python
-class MyData(Data):
-    """This is a custom Data model."""
-
-    # Add fields to the model.
-    column_1: datetime.date = Field(
-        description="The date column is a mandatory field.",
-        title="Some Date",
-    )
-    column_2: Optional[str] = Field(
-        default=None,
-        description="This is an optional string column.",
-        title="Some String",
-    )
-    column_3: int = Field(
-        default=-1,
-        description="This is an integer column.",
-        title="Some Integer",
-    )
-    column_4: float = Field(
-        default=10.25,
-        description="This is a float column.",
-        title="Some Float",
-    )
-    column_5: float = Field(
-        default=10.25,
-        description="This is a percent column.",
-        title="Some Percent",
-        json_schema_extra={"x-widget_config": {"formatterFn": "percent"}},
-    )
-    column_6: float = Field(
-        default=0.1025,
-        description="This is a normalized percent value adjusted for presentation.",
-        title="Some Normalized Percent",
-        json_schema_extra={
-            "x-widget_config": {
-                "formatterFn": "normalizedPercent",
-                "renderFn": "greenRed",
-            }
-        },
+class MyRow(Data):
+    when: date = Field(title="Date", description="Trading date")
+    pct:  float = Field(
+        title="Change",
+        json_schema_extra={"x-widget_config": {"formatterFn": "percent", "renderFn": "greenRed"}},
     )
 
-
-@app.get("/hello_data")
-async def hello_data() -> list[MyData]:
-    """Widget description created by docstring."""
-    # Do something with the parameters and return the result of work.
-    return [MyData(column_1=datetime.date.today(), column_2="Hello!")]
+@app.get("/data")
+async def data() -> list[MyRow]:
+    return [MyRow(when=date.today(), pct=0.0125)]
 ```
 
-
 ### PDF Widget
 
 To create a PDF widget, import the custom response model below and define it as a return type.
 
 The model handles conversion of the document, from a bytes object, to a base64 encoded string.
 
-
 ```python
 from openbb_platform_api.response_models import PdfResponseModel
 
@@ -402,7 +309,6 @@ async def open_pdf(
 
 To define a chart widget, update the widget "type" and return the content from the `Figure.to_plotly_json()` method.
 
-
 ```python
 @app.get(
     "/hello_chart",
@@ -437,7 +343,6 @@ The entry in `widgets.json` will be automatically created if the conditions belo
 - POST method takes 1 positional argument, a sub-class of Pydantic BaseModel.
   - Create a model, like annotated table fields, defining all inputs to the form.
 
-
 #### Example
 
 The code below creates a widget with a form as the input, and an output table of all submitted forms, as processed through the `IntakeForm` model.
@@ -600,7 +505,6 @@ async def create_omni_widget(item: TestOmniWidgetQueryModel):
 
 ![Omni Widget](https://github.com/user-attachments/assets/6a5aa886-9701-4448-b397-ed7bab99cac7)
 
-
 ## Widget Config
 
 Any value from the [`widgets.json`](https://docs.openbb.co/terminal/custom-backend/widgets-json-reference) structure can be passed into the `@app` decorator by including an `openapi_extra` dictionary with the key, `"widget_config"`.
@@ -662,7 +566,6 @@ If you would like to construct this file manually, create the file and define th
 openbb-api --widgets-json /Users/some_user/path/to/widgets.json
 ```
 
-
 ### Location of `workspace_apps.json`
 
 By default, the location is:
@@ -675,12 +578,8 @@ This can be changed by adding the path as an argument.
 openbb-api --apps-json /Users/some_user/path/to/workspace_apps.json
 ```
 
-The OpenBB Workspace allows you to export the current dashboard layout - when it is a custom backend - as a template.
-
-To export the layout, right-click on the dashboard and select, "Export apps.json".
-
-A JSON dictionary will be exported. Insert the contents of the export into "~/OpenBBUserData/workspace_apps.json" by pasting between the JSON list markers, [ ].
+The browser will warn about the untrusted cert — accept once, or add `localhost.crt` to the OS trust store.
 
-If there are more than one, add a comma between each dictionary entry.
+## License
 
-See the page [here](https://docs.openbb.co/workspace/apps#creating-your-own-app) for details on custom backend apps.
+Apache-2.0. © OpenBB.