3f44b01c23
* open draft * some table smoothing.. * fix embedded image links * bullet list cleanup * some updates..coming back to it later * saving here as a clear marker for progress * some linting * param description * some edge case... * cch cch changes * missing docstring * walk back.. * f-string * some improvements, hopefully * some improvements, hopefully * lint * use generator instead * fixes some table parsing * find the section in banks like JPM and C * fixes some cell splitting behaviour * test stuff * lock file * lock file * test things * remove commented out lines * startswith for bulletpoints.. * some more edges * O * try not to be tricked into starting at the TOC * font difference causing start not to be found. * fix wfc that calls the section something else entirely * fix target header not being all on the same line * fix target section missing Item 2 or Item 7 in text * fix for BKNG * fix different wording order in target section title * fix some error with BX * fix some nested table bullet points * fix out of range * fix to find intel's section title * fix APH issue finding start * some edge cases * Help out a lil * add 'strategy' param to select parser * some patches * allow entering CIK for symbol * update parsing bool on failed attempt * integration params * add warning when trafilatura fails, and don't insert cell dividers when (a) follows number * fix section headers * format fixes * more formatting * linter * add widget config for markdown * calendar period as Q1-Q4 enum * test param --------- Co-authored-by: James Maslek <jmaslek11@gmail.com>
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 (
DataClass): A flexible and dynamic Pydantic model capable of handling various data structures. - Standardized Query Params (
QueryParamsClass): 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 (
RouterClass): 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.