- [Quick look into the OpenBB Platform](#quick-look-into-the-openbb-platform) - [What is the Standardization Framework?](#what-is-the-standardization-framework) - [Standardization Caveats](#standardization-caveats) - [Standard QueryParams Example](#standard-queryparams-example) - [Standard Data Example](#standard-data-example) - [What is an extension?](#what-is-an-extension) - [Types of extensions](#types-of-extensions) - [How to build OpenBB extensions?](#how-to-build-openbb-extensions) - [Add a custom data source](#add-a-custom-data-source) - [OpenBB Platform commands](#openbb-platform-commands) - [QA your extension](#qa-your-extension) - [Unit tests](#unit-tests) - [Integration tests](#integration-tests) - [Import time](#import-time) - [Sharing your extension](#sharing-your-extension) - [Publish your extension to PyPI](#publish-your-extension-to-pypi) - [Setup](#setup) - [Release](#release) - [Publish](#publish) - [How to contribute to the OpenBB Platform?](#how-to-contribute-to-the-openbb-platform) - [Manage environment and dependencies](#manage-environment-and-dependencies) - [Add a new data point](#add-a-new-data-point) - [Identify which type of data you want to add](#identify-which-type-of-data-you-want-to-add) - [Check if the standard model exists](#check-if-the-standard-model-exists) - [Create Query Parameters model](#create-query-parameters-model) - [Create Data Output model](#create-data-output-model) - [Build the Fetcher](#build-the-fetcher) - [Make the provider visible](#make-the-provider-visible) - [Manage extensions](#manage-extensions) - [Add an extension as a dependency](#add-an-extension-as-a-dependency) - [How to create a PR?](#how-to-create-a-pr) - [Install pre-commit hooks](#install-pre-commit-hooks) - [Branch Naming Conventions](#branch-naming-conventions) # Quick look into the OpenBB Platform The OpenBB Platform is built by the Open-Source community and is characterized by its core and extensions. The core handles data integration and standardization, while the extensions enable customization and advanced functionalities. The OpenBB Platform is designed to be used both from a Python interface and a REST API. The REST API is built on top of FastAPI and can be started by running the following command from the root: ```bash uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload ``` The Python interfaces we provide to users is the `openbb` python package. The code you will find in this package is generated from a script and it is just a wrapper around the `openbb-core` and any installed extensions. When the user runs `import openbb`, `from openbb import obb` or other variants, the script that generates the packaged code is triggered. It detects if there are new extensions installed in the environment and rebuilds the packaged code accordingly. If new extensions are not found, it just uses the current packaged version. When you are developing chances are you want to manually trigger the package rebuild. You can do that with: ```python python -c "import openbb; openbb.build()" ``` The Python interface can be imported with: ```python from openbb import obb ``` This document will take you through two types of contributions: 1. Building a custom extension 2. Contributing directly to the OpenBB Platform Before moving forward, please take a look at the high-level view of the OpenBB Platform architecture. We will go over each bit in this document. OpenBB Platform High-Level Architecture ## What is the Standardization Framework? The Standardization Framework is a set of tools and guidelines that enable the user to query and obtain data in a consistent way across multiple providers. Each data model should inherit from a [standard data](platform/provider/openbb_provider/standard_models) model that is already defined inside the OpenBB Platform. All standard models are created and maintained by the OpenBB team. Usage of these models will unlock a set of perks that are only available to standardized data, namely: - Can query and output data in a standardized way. - Can expect extensions that follow standardization to work out-of-the-box. - Can expect transparently defined schemas for the data that is returned by the API. - Can expect consistent data types and validation. - Will work seamlessly with other providers that use the same standard model. The standard models are defined under the `/OpenBBTerminal/openbb_platform/platform/core/provider/openbb_provider/standard_models/` directory. They define the [`QueryParams`](platform/provider/openbb_provider/abstract/query_params.py) and [`Data`](platform/provider/openbb_provider/abstract/data.py) models, which are used to query and output data. They are pydantic and you can leverage all the pydantic features such as validators. ### Standardization Caveats The standardization framework is a very powerful tool, but it has some caveats that you should be aware of: - We standardize fields that are shared between two or more providers. If there is a third provider that doesn't share the same fields, we will declare it as an `Optional` field. - When mapping the column names from a provider-specific model to the standard model, the CamelCase to snake_case conversion is done automatically. If the column names are not the same, you'll need to manually map them. (e.g. `o` -> `open`) - The standard models are created and maintained by the OpenBB team. If you want to add a new field to a standard model, you'll need to open a PR to the OpenBB Platform. ### Standard QueryParams Example ```python class StockHistoricalQueryParams(QueryParams): """Stock end of day Query.""" symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", "")) start_date: Optional[date] = Field( description=QUERY_DESCRIPTIONS.get("start_date", ""), default=None ) end_date: Optional[date] = Field( description=QUERY_DESCRIPTIONS.get("end_date", ""), default=None ) ``` The `QueryParams` is an abstract class that just tells us that we are dealing with query parameters The OpenBB Platform dynamically knows where the standard models begin in the inheritance tree, so you don't need to worry about it. ### Standard Data Example ```python class StockHistoricalData(Data): """Stock end of day price Data.""" date: datetime = Field(description=DATA_DESCRIPTIONS.get("date", "")) open: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("open", "")) high: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("high", "")) low: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("low", "")) close: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("close", "")) volume: float = Field(description=DATA_DESCRIPTIONS.get("volume", "")) vwap: Optional[PositiveFloat] = Field(description=DATA_DESCRIPTIONS.get("vwap", ""), default=None) ``` The `Data` class is an abstract class that tells us the expected output data. Here we can see a `vwap` field that is `Optional`. This is because not all providers share this field while it is shared between two or more providers. ## What is an extension? An extension adds functionality to the OpenBB Platform. It can be a new data source, a new command, a new visualization, etc. ### Types of extensions We primarily have 3 types of extensions: 1. OpenBB Extensions - built and maintained by the OpenBB team (e.g. `openbb-stocks`) 2. Community Extensions - built by anyone and primarily maintained by OpenBB (e.g. `openbb-yfinance`) 3. Independent Extensions - built and maintained independently by anyone If your extension is of high quality and you think that it would be a good community extension, you can open a PR to the OpenBB Platform repository and we'll review it. We encourage independent extensions to be shared with the community by publishing them to PyPI. # How to build OpenBB extensions? We have a Cookiecutter template that will help you get started. It serves as a jumpstart for your extension development, so you can focus on the data and not on the boilerplate. Please refer to the [Cookiecutter template](https://github.com/OpenBB-finance/openbb-cookiecutter) and follow the instructions there. This document will walk you through the steps of adding a new extension to the OpenBB Platform. The high level steps are: - Generate the extension structure - Install your dependencies - Install your new package - Use your extension (either from Python or the API interface) - QA your extension - Share your extension with the community ## Add a custom data source You will get your data either from a CSV file, local database or from an API endpoint. If you don't want or don't need to partake in the data standardization framework, you have the option to add all the logic straight inside the router file. This is usually the case when you are returning custom data from your local CSV file, or similar. Keep in mind that we also serve the REST API and that you shouldn't send non-serializable objects as a response (e.g. a pandas dataframe). Saying that, we highly recommend following the standardization framework, as it will make your life easier in the long run and unlock a set of features that are only available to standardized data. When standardizing, all data is defined using two different pydantic models: 1. Define the [query parameters](platform/provider/openbb_provider/abstract/query_params.py) model. 2. Define the resulting [data schema](platform/provider/openbb_provider/abstract/data.py) model. > The models can be entirely custom, or inherit from the OpenBB standardized models. > They enforce a safe and consistent data structure, validation and type checking. We call this the ***Know-Your-Data*** principle. After you've defined both models, you'll need to define a `Fetcher` class which contains three methods: 1. `transform_query` - transforms the query parameters to the format of the API endpoint. 2. `extract_data` - makes the request to the API endpoint and returns the raw data. 3. `transform_data` - transforms the raw data into the defined data model. > Note that the `Fetcher` should inherit from the [`Fetcher`](platform/provider/openbb_provider/abstract/fetcher.py) class, which is a generic class that receives the query parameters and the data model as type parameters. After finalizing your models, you need to make them visible to the Openbb Platform. This is done by adding the `Fetcher` to the `__init__.py` file of the `/` folder as part of the [`Provider`](platform/provider/openbb_provider/abstract/provider.py). Any command, that uses the `Fetcher` class you've just defined, will be calling the `transform_query`, `extract_data` and `transform_data` methods under the hood in order to get the data and output it do the end user. If you're not sure what's a command and why is it even using the `Fetcher` class, follow along! ### OpenBB Platform commands The OpenBB Platform will enable you to query and output your data in a very simple way. > Any Platform endpoint will be available both from a Python interface and the API. The command definition on the Platform follows [FastAPI](https://fastapi.tiangolo.com/) conventions, meaning that you'll be creating **endpoints**. The Cookiecutter template generates for you a `router.py` file with a set of examples that you can follow, namely: - Perform a simple `GET` and `POST` request - without worrying on any custom data definition. - Using a custom data definition so you get your data the exact way you want it. You can expect the following endpoint structure when using a `Fetcher` to serve the data: ```python @router.command(model="Example") def model_example( cc: CommandContext, provider_choices: ProviderChoices, standard_params: StandardParams, extra_params: ExtraParams, ) -> OBBject[BaseModel]: """Example Data.""" return OBBject(results=Query(**locals()).execute()) ``` Let's break it down: - `@router.command(...)` - this tells the OpenBB Platform that this is a command. - `model="Example"` - this is the name of the `Fetcher` dictionary key that you've defined in the `__init__.py` file of the `/` folder. - `cc: CommandContext` - this contains a set of user and system settings that is useful during the execution of the command - eg. api keys. - `provider_choices: ProviderChoices` - all the providers that implement the `Example` `Fetcher`. - `standard_params: StandardParams` - standardized parameters that are common to all providers that implement the `Example` `Fetcher`. - `extra_params: ExtraParams` - it contains the provider specific arguments that are not standardized. You only need to change the `model` parameter to the name of the `Fetcher` dictionary key and everything else will be handled by the OpenBB Platform. ## QA your extension We are strong believers in the QA process and we want to make sure that all the extensions that are added to the OpenBB Platform are of high quality. To ensure this, we have a set of QA tools that you can use to test your extension. Primarily, we have tools that semi-automate the creation of unit and integration tests. > The QA tools are still in development and we are constantly improving them. ### Unit tests Each `Fetcher` comes equipped with a `test` method that will ensure that it is implemented correctly and that it is returning the expected data. It also ensures that all types are correct and that the data is valid. To create unit tests for your Fetchers, you can run the following command: ```bash python openbb_platform/providers/tests/utils/unit_test_generator.py ``` > Note that you should be running this file from the root of the repository. The automatic unit test generation will add unit tests for all the fetchers available in a given provider. > Note that sometimes manual intervention is needed. For example, adjusting out-of-top level imports or adding specific arguments for a given fetcher. ### Integration tests The integration tests are a bit more complex than the unit tests, as we want to test both the Python interface and the API interface. For this, we have two scripts that will help you generate the integration tests. To generate the integration tests for the Python interface, you can run the following command: ```bash python openbb_platform/extensions/tests/utils/integration_tests_generator.py ``` To generate the integration tests for the API interface, you can run the following command: ```bash python openbb_platform/extensions/tests/utils/integration_tests_api_generator.py ``` When testing the API interface, you'll need to run the OpenBB Platform locally before running the tests. To do so, you can run the following command: ```bash uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload ``` These automated tests are a great way to reduce the amount of code you need to write, but they are not a replacement for manual testing and might require tweaking. That's why we have unit tests that test the generated integration tests to ensure they cover all providers and parameters. To run the tests we can do: - Unit tests only: ```bash pytest openbb_platform -m "not integration" ``` - Integration tests only: ```bash pytest openbb_platform -m integration ``` - Both integration and unit tests: ```bash pytest openbb_platform ``` ### Import time We aim to have a short import time for the package. To measure that we use `tuna`. - To visualize the import time breakdown by module and find potential bottlenecks, run the following commands from `openbb_platform` directory: ```bash pip install tuna python -X importtime openbb/__init__.py 2> import.log tuna import.log ``` ## Sharing your extension We encourage you to share your extension with the community. You can do that by publishing it to PyPI. ### Publish your extension to PyPI To publish your extension to PyPI, you'll need to have a PyPI account and a PyPI API token. #### Setup Create an account and get an API token from Store the token with ```bash poetry config pypi-token.pypi pypi-YYYYYYYY ``` #### Release `cd` into the directory where your extension `pyproject.toml` lives and make sure that the `pyproject.toml` specifies the version tag you want to release and run. ```bash poetry build ``` This will create a `/dist` folder in the directory, which will contain the `.whl` and `tar.gz` files matching the version to release. If you want to test your package locally you can do it with ```bash pip install dist/openbb_[FILE_NAME].whl ``` #### Publish To publish your package to PyPI run: ```bash poetry publish ``` Now, you can pip install your package from PyPI with: ```bash pip install openbb-some_ext ``` # How to contribute to the OpenBB Platform? There are many ways to contribute to the OpenBB Platform. You can add a new data point, add a new command, add a new visualization, add a new extension, fix a bug etc. In this document, we'll be focusing on adding a new data point to the OpenBB Platform. ## Manage environment and dependencies In order to contribute to the OpenBB Platform, you need to setup your environment to ensure a smooth development experience.
Need help setting up Miniconda or Git? Sometimes, installing Miniconda or Git can be a bit tricky, so we've prepared a set of instructions to help you get started. Please refer to [OpenBBTerminal docs](https://docs.openbb.co/terminal/installation/source) for more information.
1. Clone the repository: ```bash git clone git@github.com:OpenBB-finance/OpenBBTerminal.git ``` 2. Create and activate a virtual environment: ```bash conda create -n "obb-dev" python=3.9.13 conda activate obb-dev ``` > Supported python versions: python = ">=3.8,<3.12" 3. Manage your environment with [Poetry](https://python-poetry.org/): ```bash pip install poetry ``` 4. Install the packages using the `dev_install.py` script located in the `openbb_platform` folder: ```bash python dev_install.py ``` > To install all the packages, including extras, use the `-e` argument with the above script. 5. Setup your API keys locally by adding them to the `~/.openbb_platform/user_settings.json` file. Populate this file with the following template and replace the values with your keys: ```json { "credentials": { "fmp_api_key": "REPLACE_ME", "polygon_api_key": "REPLACE_ME", "benzinga_api_key": "REPLACE_ME", "fred_api_key": "REPLACE_ME" } } ``` > You can also setup and use your keys from the OpenBB Hub and the Python interface at runtime. Follow the steps in [API Keys](./README.md#api-keys) section to know more about it. ## Add a new data point In this section, we'll be adding a new data point to the OpenBB Platform. We will add a new provider with an existing [standard data](platform/provider/openbb_provider/standard_models) model. ### Identify which type of data you want to add In this example, we'll be adding OHLC stock data that is used by the `obb.stocks.load` command. Note that, if no command exists for your data, we need to add one under the right router. Each router is categorized under different extensions (stocks, forex, crypto, etc.). #### Check if the standard model exists Given the fact that there's already an endpoint for OHLCV stock data, we can check if the standard exists. In this case, it's `StockHistorical` which can be found inside the `/OpenBBTerminal/openbb_platform/platform/core/provider/openbb_provider/standard_models/` directory. If the standard model doesn't exist: - you won't need to inherit from it in the next steps. - all your provider query parameters will be under the `**kwargs` in the python interface. - it might not work out-of-the box with other extensions that follow standardization e.g. the `charting` extension #### Create Query Parameters model Query Parameters are the parameters that are passed to the API endpoint in order to make the request. For the `StockHistorical` example, this would look like the following: ```python class StockHistoricalQueryParams(StockHistoricalQueryParams): """ Stock Historical Query. Source: https://www..co/documentation/ """ # provider specific query parameters if any ``` #### Create Data Output model The data output is the data that is returned by the API endpoint. For the `StockHistorical` example, this would look like the following: ```python class StockHistoricalData(StockHistoricalData): """ Stock End of Day Data. Source: https://www..co/documentation/ """ # provider specific data output fields if any ``` > Note that, since `StockHistoricalData` inherits from pydantic's `BaseModel`, we can leverage validators to perform additional checks on the output model. A very good example of this, would be to transform a string date into a datetime object. #### Build the Fetcher The `Fetcher` class is responsible for making the request to the API endpoint and providing the output. It will receive the Query Parameters, and it will return the output while leveraging the pydantic model schemas. For the `StockHistorical` example, this would look like the following: ```python class StockHistoricalFetcher( Fetcher[ StockHistoricalQueryParams, List[StockHistoricalData], ] ): """Transform the query, extract and transform the data.""" @staticmethod def transform_query(params: Dict[str, Any]) -> StockHistoricalQueryParams: """Transform the query parameters.""" return StockHistoricalQueryParams(**transformed_params) @staticmethod def extract_data( query: StockHistoricalQueryParams, credentials: Optional[Dict[str, str]], **kwargs: Any, ) -> dict: """Return the raw data from the endpoint.""" obtained_data = my_request(query, credentials, **kwargs) return obtained_data @staticmethod def transform_data( data: dict, ) -> List[StockHistoricalData]: """Transform the data to the standard format.""" return [StockHistoricalData.model_validate(d) for d in data] ``` > Make sure that you're following the TET pattern when building a `Fetcher` - **Transform, Extract, Transform**. ### Make the provider visible In order to make the new provider visible to the OpenBB Platform, you'll need to add it to the `__init__.py` file of the `providers//openbb_/` folder. ```python """ Provider module.""" from openbb_provider.abstract.provider import Provider from openbb_.models.stock_eod import StockHistoricalFetcher _provider = Provider( name="", website="", description="Provider description goes here", required_credentials=["api_key"], fetcher_dict={ "StockHistorical": StockHistoricalFetcher, }, ) ``` If the provider does not require any credentials, you can remove that parameter. On the other hand, if it requires more than 2 items to authenticate, you can add a list of all the required items to the `required_credentials` list. After running `pip install .` on `openbb_platform/providers/` your provider should be ready for usage, both from the Python interface and the API. ## Manage extensions To install an extension hosted on PyPI, use the `pip install ` command. To install an extension that is developed locally, ensure that it contains a `pyproject.toml` file and then use the `pip install ` command. > To install the extension in editable mode using pip, add the `-e` argument. Alternatively, for local extensions, you can add this line in the `LOCAL_DEPS` variable in `dev_install.py` file: ```toml # If this is a community dependency, add this under "Community dependencies", # with additional argument optional = true openbb-extension = { path = "", develop = true } ``` Now you can use the `python dev_install.py [-e]` command to install the local extension. ### Add an extension as a dependency To add the `openbb-qa` extension as a dependency, you'll need to add it to the `pyproject.toml` file: ```toml [tool.poetry.dependencies] openbb-qa = "^0.0.0a2" ``` Then you can follow the same process as above to install the extension. ## How to create a PR? To create a PR to the OpenBB Platform, you'll need to fork the repository and create a new branch. 1. Create your Feature Branch, e.g. `git checkout -b feature/AmazingFeature` 2. Check the files you have touched using `git status` 3. Stage the files you want to commit, e.g. `git add openbb_terminal/stocks/stocks_controller.py openbb_terminal/stocks/stocks_helper.py`. Note: **DON'T** add any files with personal information. 4. Write a concise commit message under 50 characters, e.g. `git commit -m "meaningful commit message"`. If your PR solves an issue raised by a user, you may specify such issue by adding #ISSUE_NUMBER to the commit message, so that these get linked. Note: If you installed pre-commit hooks and one of the formatters re-formats your code, you'll need to go back to step 3 to add these. ### Install pre-commit hooks To install pre-commit hooks, run `pre-commit install` in the root of the repository. ### Branch Naming Conventions The accepted branch naming conventions are: - `feature/feature-name` - `hotfix/hotfix-name` These branches can only have PRs pointing to the `develop` branch.