mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 04:52:07 +00:00

Files

James Maslek 919d5a60bb Adding OECD Endpoints (CPI + Share Price Index) (#6157 )

* remove ultima + althub

* move twitter keys

* Enhance caching + more specific urls

* Update urls for stir

* LTIR

* cli

* one v3 file to fix

* Typing edits + gdp dates + gdp all countries

* Tests

* lint

* not sure why those didnt record

* handle the fact that we artifically add some start dates and end dates

* fix dates with actual solution not weird patch

* lint

* Add CPI from OECD

* coment

* Add Share Price endpoint

* Clean up the CPI oecd model with the choices and allow expensitures to be "all"

* commit this change

* remove "share prices"

* Correctly handle country "choices" and let oecd do multiple countries

* some fixes

* standard model fields

* unit test

* frequency in standard model

* empty fred

* format oecd dates as period beginning

* fred -> when frequency is annual, the transform needs to be same period one year ago

* test thing

* add share price index

* test params

* better parsing with CSV response

* update test cassette

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

2024-05-29 21:35:37 +00:00

integration

[Enhancement] - PyDocstyle Compliant (#6284 )

2024-04-09 13:30:29 +00:00

openbb_core

Adding OECD Endpoints (CPI + Share Price Index) (#6157 )

2024-05-29 21:35:37 +00:00

tests

[Feature] Set provider fallback based on credentials (#6446 )

2024-05-29 14:22:14 +00:00

poetry.lock

Run linters on changed files only (#6458 )

2024-05-23 12:55:31 +00:00

pyproject.toml

Run linters on changed files only (#6458 )

2024-05-23 12:55:31 +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.