mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
* add standardized financial statements to sec provider * codespell * add type annotation to json_schema_extra dict * test params * mypy * pylint * if no actual quarterly data is reported by 20/40-F, raise an error when requesting it * Fix D&A parent double count rollups * some updates * codespell * breakout statement_schema into smaller files * balance sheet ordering * reorganize the results metadata output to OBBject * unused import * restore sec_filing.py file - not in scope * organize imports * AdjustmentsNoncashItemsToReconcileNetIncomeLossToCashProvidedByUsedInOperatingActivitiesOther * fix docstring * linter --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Providers
In this folder you can find the providers that were created or are supported by OpenBB.
Recommended structure
Every provider is located within a directory, with the following structure:
openbb_platform
└───providers
└───<provider_name>
| README.md
│ pyproject.toml
│ poetry.lock
|───tests
└───openbb_<provider_name>
│ __init__.py
|───models
| |───<some model>.py
| └───...
└───utils
|───<some helper>.py
└───...
The models define the data structures that are used to query the provider endpoints and store the response data.
See CONTRIBUTING file for more details