mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00

Files

teh_coderer da7886d0a7 Make Pro Fetchers async by replacing ThreadPoolExecutor with asyncio.gather (#5822 )

* init

* Update helpers.py

* filter URL on raise

* polygon, fmp done, update cassettes

* updates

* cleanup

* revert tests for now

* Update discovery_filings.py

* Update helpers.py

* add `async` overload to `Fetcher.extract_data`

* update merged fred models

* tests, improve fred series

* Update insider_trading.py

* insider

* tests

* intrinio

* Update equity_historical.py

* implement abstract async extract on Fetcher, with simple switch

* cleanup

* Update helpers.py

* Update helpers.py

* fix fmp historical deprecated urls

* Revert "fix fmp historical deprecated urls"

This reverts commit 1a760a2473.

* fix fmp `index.market` 1day url missing query params

* Update test_fmp_market_indices_fetcher.yaml

* field fixes

* `extract_data_async` -> `aextract_data`, `async_request` -> `amake_request`

* `async_requests` -> `amake_requests`

* Update company_news.py

* add sort to index `integration` params

* add `client.py` tests

* Update equity_search.py

* Add lost v in platform api version string

* Resolve linter errors here and there

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

2023-12-08 14:41:37 +00:00

integration

Merge provider and core into core (#5774 )

2023-11-22 13:48:01 +00:00

openbb_core

Make Pro Fetchers async by replacing ThreadPoolExecutor with asyncio.gather (#5822 )

2023-12-08 14:41:37 +00:00

tests

Make Pro Fetchers async by replacing ThreadPoolExecutor with asyncio.gather (#5822 )

2023-12-08 14:41:37 +00:00

poetry.lock

Hotfix/unskip tests (#5851 )

2023-12-04 15:45:46 +00:00

pyproject.toml

Hotfix/unskip tests (#5851 )

2023-12-04 15:45:46 +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.