mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 20:42:26 +00:00

Files

Pratyush Shukla 540f578852 [Enhancement] ReferenceGenerator class in package_builder.py (#6179 )

* fix docstrings in quantitative,technical,econometrics routers

* add reference generator class to create reference.json file in openbb/assets folder

* modify platform markdown generator script to not generate the reference.json file

* get properly formatted examples for the website

* modify get_field_type function

* remove TODO comment

* path change / to .

* remove extra '-' below 'Args' in function docstring

* get obbject extensions in extension_map.json

* skew in stats_router had extra . rip

* black

* extra space (sigh)

* modify get_provider_parameter_info func to use model_provider from provider interface

* update lock files

* black

* Revert "update lock files"

This reverts commit 13e7d8b280.

* add function to check all extensions are installed before the markdow generator runs

* better comment

* fix docstring

fix mypy

obbject description function

* black

* 'static

* remove duplicate standard params & data from reference data

add standard params & data fields while generating markdown files

2024-03-13 17:30:10 +00:00

integration

fix intraday check in charting ta_class (#6119 )

2024-02-28 08:51:40 +00:00

openbb_core

[Enhancement] ReferenceGenerator class in package_builder.py (#6179 )

2024-03-13 17:30:10 +00:00

tests

[Enhancement] ReferenceGenerator class in package_builder.py (#6179 )

2024-03-13 17:30:10 +00:00

poetry.lock

[Feature] Hotfix develop main sync (#6200 )

2024-03-13 12:34:17 +00:00

pyproject.toml

[Feature] Hotfix develop main sync (#6200 )

2024-03-13 12:34:17 +00:00

README.md

fix: minor typos in the docs (#5854 )

2023-12-05 14:39:42 +00:00

README.md

OpenBB Platform - Core

Overview

The Core extension serves as the foundational component of the OpenBB Platform. It encapsulates essential functionalities and serves as an infrastructural base for other extensions. This extension is vital for maintaining the integrity and standardization of the platform.

Key Features

Standardized Data Model (Data Class): A flexible and dynamic Pydantic model capable of handling various data structures.
Standardized Query Params (QueryParams Class): A Pydantic model for handling querying to different providers.
Dynamic Field Support: Enables handling of undefined fields, providing versatility in data processing.
Robust Data Validation: Utilizes Pydantic's validation features to ensure data integrity.
API Routing Mechanism (Router Class): Simplifies the process of defining API routes and endpoints - out of the box Python and Web endpoints.

Getting Started

Prerequisites

Python 3.8 or higher.
Familiarity with FastAPI and Pydantic.

Installation

Installing through pip:

pip install openbb-core

Note that, the openbb-core is an infrastructural component of the OpenBB Platform. It is not intended to be used as a standalone package.

Usage

The Core extension is used as the basis for building and integrating new data sources, providers, and extensions into the OpenBB Platform. It provides the necessary classes and structures for standardizing and handling data.

Contributing

We welcome contributions! If you're looking to contribute, please:

Follow the existing coding standards and conventions.
Write clear, documented code.
Ensure your code does not negatively impact performance.
Test your contributions thoroughly.

Please refer to our Contributing Guidelines.

Collaboration

Engage with the development team and the community. Be open to feedback and collaborative discussions.

Support

For support, questions, or more information, please visit OpenBB Platform Documentation.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.