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

Files

montezdesousa f328a45b95 [Feature] - refactor examples (#6154 )

* remove auto examples and split python from api

* add missing exampels

* rebuild

* query params focstring

* black

* add scoped examples

* group model imports in the router

* unblock api

* fix

* classify examples

* fix package identation

* black sig

* fix indentation without linter

* fix python examples

* remove doc

* pylint

* again

* add model validators

* commodity, crypto, currency

* filter examples

* fix python examples

* fix filter and build

* undo toml change

* add comment

* oop

* comment

* typing

* lint

* Update router.py

* Update econometrics_router.py

* fix to_python

* to_python

* to_python

* black

* fix multiple line field descriptions

* remove circular import

* add missing import

* pass indent as object attr

* doc

* doc

* this looks better

* forgot this

* fix: new examples adapted

* fix prev commit

* avoid future problems

* Update ownership_router.py

* rebuild + remove todo

* make description mandatory for python examples

* simple indent

* append_examples func works for both website and docstring

* Add example unit tests

* Edit example unit tests

* fix validator

* this works

* fix to_python

* fix mandatory docstrings

* typing

* shorter error msgs

* economy router

* fix more examples

* more examples

* more examples

* more examples

* field desc

* minor fix

* fix etf examples

* handling types better

* lint

* rename method

* rename var

* docstring + move method

* typing

* prompt

* rebuild

* prompt fix in PythonEx

* fix examples without model

* example mock data

* add get_field_type func to get field data type

* panel data

* mock data

* fix

* fix

* docstring

* ohlcv

* pylint

* quantitaive router

* simplify mock data

* fix remaining quantitative routers

* a bit more flexibility for examples

* lint

* mock dat from sample

* docstring

* assertion

* bugfix

* minor fix

* technical

* fix integration tests

* fix docstring

* econometrics examples

* econometrics examples

* remove warning

* add technical examples

* fix bad examples

* fix more examples

* update test rules

* remoce old pydantic referenc

* fix bug in treasury prices

* fix quantitative examples

* discovery router

* equity shorts

* equity shorts

* fix currency pairs

* fix sec_router example

* fix panel data to support all funcs

* black

* more examples fixes

* simplify test

* rebuild

* test doc

* add provider to some ex

* ^

* last

* add provider

* rebuild

* working examples

* noqa

* pylint

* pylint

* clean

* minor fix

* fix test

* lint

* ruff

---------

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>

2024-03-09 23:22:40 +00:00

integration

[Enhancement] Standardize "X".price.historical Intervals and Params (#6146 )

2024-03-08 16:31:38 +00:00

openbb_equity

[Feature] - refactor examples (#6154 )

2024-03-09 23:22:40 +00:00

tests

OpenBB Platform v4 (#5225 )

2023-11-13 15:03:31 +00:00

poetry.lock

Release/4.1.4 (#6081 )

2024-02-15 11:37:00 -05:00

pyproject.toml

Release/4.1.4 (#6081 )

2024-02-15 11:37:00 -05:00

README.md

docs/working-docs: Working V4 Docs PR (#5747 )

2023-11-20 20:14:00 +00:00

README.md

OpenBB Equity Extension

This extension provides equity market data tools for the OpenBB Platform.

Features of the Equity extension include:

Access to various equity market data sources
Sub-modules such as:
- calendar for equity-specific events
- compare for peer analysis
- darkpool for dark pool shorts data
- discovery for equity discovery
- estimates for analyst estimates
- fundamental for fundamental analysis
- options for options
- ownership for internal and external ownership
- price for historical pricing data
- shorts for shorts data

Installation

To install the extension, run the following command in this folder:

pip install openbb-equity

For development please check Contribution Guidelines.

Documentation available here.