d75b22f819
* add SSL certificate context and setting
* codespell
* linting
* cleanup section
* allow defining uvicorn.run kwargs in system_settings
* refactor to return session objects
* hub service rename it as _request_session
* typing
* more linting
* pylint
* missing __init__ files
* fix test_hub_service
* missing init files..?
* shouldn't need an init file there..
* now for some random linting
* maybe need that __init__ after all...?
* fix test_make_request
* relative import in conftest..?
* issue can't be from missing init files..
* revert the inits
* small cleanup
* pass the kwargs to the async session object on init for use outside of amake_request
* try something...
* try something else..
* turn on verbosity for errors..
* try something else...
* undo test change
* Update lock files
* undo another test check thing
* Revert "Update lock files"
This reverts commit 714df64416.
* try with just the platform lock
* unexpected argument
* do a dummy check to return the session object if it is passed in the kwargs
* also dummy check for TCPConnector instance
* bit more cleanup
* no implementation of server_hostname
* Move setting session to PosthogHandler init
* add comments
* review items
* update PythonSettings model definitions and annotations
* fix latest yfinance breaking changes
* unused import
---------
Co-authored-by: Theodore Aptekarev <aptekarev@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.