jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 12:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b0ee9d64c2fa260346cc8b8c90068b8320636a8a
OpenBB/openbb_platform/core
History
Danglewood b0ee9d64c2 [Feature] IMF Port Watch (#7134) 
* add imf port watch data and shipping route to economy router

* more files

* python 3.9 tests

* uncomment out item

* codespell

* remove old references from codespell

* codespell

* test params

* black

* no-redef

* no-redef

* pylint

* more cleanup

* remove commented out lines

* linting

* test params

* test params and linter

* black

* black

* add maxRecordCountFactor

* test cassettes

* Fix lints

* Fix typo

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
2025-06-04 17:28:15 +00:00
..
integration
[BugFix] Pre release fixes (#6478)
2024-06-04 13:16:07 +00:00
openbb_core
[Feature] IMF Port Watch (#7134)
2025-06-04 17:28:15 +00:00
tests
remove posthog from code (#7136)
2025-06-02 18:16:50 +00:00
__init__.py
[BugFix] Bump openbb-core Dependencies In pyproject.toml (#6794)
2024-10-22 15:46:45 +00:00
poetry.lock
remove posthog from code (#7136)
2025-06-02 18:16:50 +00:00
pyproject.toml
remove posthog from code (#7136)
2025-06-02 18:16:50 +00:00
README.md
[Release] Merge Release 4.3.5 From Main To Develop (#6979)
2024-11-30 23:56:38 +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.9 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.