Metadata-Version: 2.1
Name: openbb-platform-pro-backend
Version: 1.1.0
Summary: Widgets JSON for OpenBB Terminal Pro
Author: OpenBB Team
Author-email: hello@openbb.co
Requires-Python: >=3.9,<3.13
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: openbb-charting (>=2.2.0,<3.0.0)
Requires-Dist: openbb_core (>=1.3.0,<2.0.0)
Description-Content-Type: text/markdown

# OpenBB Platform backend for OpenBB Terminal Pro

The application in this repository wraps the OpenBB Platform API in a way that it:

1. Creates a widgets.json from the OpenAPI schema
2. Creates the widgets.json and root ("/") endpoints for the OpenBB Platform API

## Installation

Install from pypi _into the same python environment as your OpenBB Platform_:

```bash
pip install openbb-platform-pro-backend
```

## Running

The package provides a shortcut to launch the application using:

```bash
openbb-api
```

**:note:** If this command is not available immediately after installation, you need to deactivate and activate back your virtual environment.

**:note:** Set up your provider API keys in the `~/.openbb_platform/user_settings.json` file.

## Configuring host and port

You can configure the host and port by setting the `OPENBB_API_HOST` and `OPENBB_API_PORT` environment variables.

