jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 04:52:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
31d03eb5f1dec22f9a4c9876b6532a9b4fd3935a
OpenBB/openbb_platform/core
History
Henrique Joaquim 31d03eb5f1 equity.estimates.price_target - Integrate with Benzinga (#5946) 
* deprecation message

* fix lints

* adding equity.estimates.ratings and fmp as its provider

* unit tests for fmp

* removing unused file

* typos

* add benzinga to AnalystRatings

* revert changes to estimates router

* moving it to price target instead

* reverting changes

* fmp support for multiple ticker

* benzinga price target

* ruffy

* unused argument

* fix type hints

* tests for the new fetcher

* new integration tests

* fixing tests

* missing std arg

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
2024-01-17 18:39:40 +00:00
..
integration
Merge provider and core into core (#5774)
2023-11-22 13:48:01 +00:00
openbb_core
equity.estimates.price_target - Integrate with Benzinga (#5946)
2024-01-17 18:39:40 +00:00
tests
Log custom headers (#5966)
2024-01-17 12:22:29 +00:00
poetry.lock
Release/4.1.0 (#5901)
2024-01-03 18:17:37 -05:00
pyproject.toml
Release/4.1.0 (#5901)
2024-01-03 18:17:37 -05: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.