Commit Graph

738 Commits

Author SHA1 Message Date
montezdesousa
c06410746f [Feature] - Excel help page (#6165)
* create help page

* rename file

* words

* words

* more issues

* less words

* minor fix

* email

* no bare urls

* unused attribute

* ruff
2024-03-05 12:00:28 +00:00
montezdesousa
b60d90875f Docs/update xl docs (#6145)
* remove print

* update obb.get docs

* example

* md lint
2024-02-28 22:09:11 +00:00
Danglewood
37209c88ea add more examples into findSymbols (#6139)
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2024-02-28 18:49:16 +00:00
montezdesousa
2332725834 update functions.json (#6140) 2024-02-27 19:10:06 +00:00
montezdesousa
ccdb246cda [Feature] - Sync with new openapi.json (#6137)
* feat: create data tabs

* fix: uncomment

* fix: remove unecessary comment

* sort side bar

* comment

* uncomment

* use .dev functions.json + clean traverse

* fix futures example

* fix example

* point to .co
2024-02-27 18:21:16 +00:00
Pratyush Shukla
577a42461d [Feature] - Platform V4 Markdown Generator V2 (#6094)
* add recent `openapi.json`

* fix data types in models

* removed `openapi.json`

* set default date value as None in PolygonCurrencyPairs class

* add function to generate reference.json file

* reworked function to improve readability

* reword function to add seo metadata

* add functions for creating markdown sections

* add code to extract data card markdown title

* add additional functions for generating index and data models file

* extract first sentence of the description for cards

* code cleanup and documentation

* linting

* linting polygon models

* add openbb import statement in create_reference_markdown_examples function

* add POST method functions

* cleanup; reworked generate_reference_index_files function

* moved development section to 7th position in the sidebar

* fix POST function params default value

add standard flag to QueryParams and Data fields

cleanup

* add type expansion from package_builder.MethodDefinition

* sort data models cards alphabetically

make printing less verbose

* make MAX_CARDS global

display less content in cards in Commannds section

* cleanup

* Remove '_' from the cards under Commands section

* " to ' in econometrics/causality

* replace ' with " in ReferenceCard for reference dir index files

* remove extra . from the quantile function description

* shoutout to @deeleeramone for finding POST method description bug!

* set correct value for standard field

* handle BaseModel types in provider data fields

* unit tests for the platform markdown generator v2

* yeet 'Default' and 'Optional' columns in the 'Data' section

* last minute bug fix

* add info for multiple symbols

* make multiple items info same as platform static

* organize sections properly

* sort reference sub-directories alphabetically

* extra space in 'OBBject extra' description

* add type expansion for fields with multiple items

POST method cleanup

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
2024-02-27 11:20:28 +00:00
Michael Struwig
da79144493 [Docs] Update OpenBB Copilot docs (#6106)
* WIP: Tweak description.

* WIP: Experimenting with react-player

* WIP: Add copilot docs.

* fixes videos width/height

* WIP: Refine videos and copy.

* WIP: Add last videos and sections.

* Add bring-your-own-copilot section.

* Tweak grammar.

* Add copilot link.

* Fix typos.

---------

Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
2024-02-26 13:03:02 +00:00
Danglewood
6c105df82f update extensions list (#6114) 2024-02-23 08:04:04 +00:00
Danglewood
ad2dae277d [Docs] Remove Reference to to_chart in OBBject. (#6096)
* remove reference to to_chart in OBBject.

* put chart description back in OBBject properties
2024-02-21 09:05:38 +00:00
montezdesousa
f8a5f5fb37 [Feature] - OBB.GET (#6097)
* create OBB.GET and data slicer page

* remove quotes

* format description

* wording

* functions.json

* sidebar position

* remove if stamente
2024-02-20 23:48:27 +00:00
Henrique Joaquim
2f01e954d1 Feature/charting obbject (#5938)
* fix circular import issues on the obbject extension framework

* settings available on the obbject

* extension init

* charting assets and code

* introduce to_chart functionality

* removes the to_chart method from obbject in detriment of the one from the obbject extension

* Update openbb_platform/obbject_extensions/charting/charting/__init__.py

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>

* fix on the show method

* adding the example to the to_chart docstring

* copying the exsting README from charting extension - needs to be revamped

* moving to openbb_charting instead

* update the pyproject.toml file

* pydocstyle

* versions

* better docstrings

* making accessors public

* removing unnecessary credentials variable cc @montezdesousa

* removing access to extra/metadata and use designated private attrs instead

* Fixes linting for the logging service (#5992)

* lints

* typing.Type instead

* deprecating ChartingService to use the new extension instead - adding function discovery capabilities using it

* tests for the obbject charting extension

* removing charting service from command runner

* filter functions not implemented in the module

* remove charting service tests

* removing charting service on the tests for int tests

* charting integration tests

* removing charting service file

* removing old charting extension code

* revamp builder

* fix obbject tests

* fix command_runner tests

* removing openbb_figure_table

* better website docs

* reviewed readme

* unsetting api key for posthog (pywry) windows

* added debug_mode to the system settings

* removing api key

* update nightly script

* fix tests

* black

* black

* Revert "black"

This reverts commit 21d76ad689.

* Revert "black"

This reverts commit 0904653fd7.

* black for henrique

* returning a list instead

* better docstrings

* removing unnecessary indicators docstring

* typo

* black

* intentional access to protected member

* changes to publish script

* filtering deleted files

* black

* adding render argument

* fixing the df_to_basemodel function: it should include the index in the columns either if flagged or if the index is named

* adding the hability to add you own data to to_chart method

* tests

* black

* disable protected access

* accept kwargs to eg. save image

* adjustment cc Igor

* add if statement for protection

* remove unused return typing

* fix technical charting views

* better error message cc @IgorWounds

* better structure and fix test

* Revert "better structure and fix test"

This reverts commit 612ea6117c.

* Revert "better error message cc @IgorWounds"

This reverts commit 3d7ee53878.

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2024-02-14 15:19:27 +00:00
Igor Radovanovic
3ca266d9b4 Remove the preference (#6055)
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
2024-02-08 12:04:49 +00:00
montezdesousa
aa1fab6f28 display warnings based on preference (#6051) 2024-02-07 19:18:21 +00:00
montezdesousa
38d79d0dc3 Sync excel reference (#6039)
* sync excel reference

* fix: change delimiter to comma

* feat: update data connectors

* test skipping wf

* Update unit-test.yml

* Update unit-test.yml

* test skipping wf

* watch label changes

* Update unit-test.yml
2024-02-07 12:24:12 +00:00
montezdesousa
1cff417f10 Fix data connectors link typo (#6038) 2024-02-06 12:48:11 +00:00
montezdesousa
a75d32610b Docs/byod (#5996)
* add byod to reference

* fix: rename add-in name

* feat: add data conectors page

* fix: additional notes

* tiny tweaks

* update functions.json and openapi.json

* fix: fix bug in hedge controller

* fix: another bug hedgecontroller

* black

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2024-02-05 17:01:15 +00:00
Igor Radovanovic
f86483e683 [Feature] - Refactor Response Model (#6024)
* Start refactor with @montezdesousa

* feat: add response model inside openapi_extra

* feat: find+replace return types

* fix: ruff

* Feature/api response by provider (#6029)

* init

* Update router.py

* Update registry_map.py

* check dicts

* lint

* exclude provider on data model for package build

* `results_type_repr` logic for `Annotated`, ignore provider field in `_extract_data`

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
2024-02-05 13:17:29 +00:00
Henrique Joaquim
d4baba0284 [Feature] - Custom deprecation (#6005)
* custom deprecation

* custom deprecation

* using the new deprecation

* custom deprecation on the package builder

* remove comment

* ruff

* black

* static assets

* tests

* using parametrization instead

* test for deprecated endpoints (#6014)

* Deprecation warning on the reference docs (#6015)

* typo/fix

* bring back methods needed for markdown generation

* add deprecation warning to docs

* contributor docs for deprecating endpoints - tks @deeleeramone

* small changes on publishing procedure per @the-praxs

* moving the deprecation summary class to deprecation file instead

* explanation on class variables

* Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>

* Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>

* Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>

* Update openbb_platform/openbb/package/index.py

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>

* Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>

* Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>

* deprecating on 4.3 instead @the-praxs

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2024-02-01 10:00:47 +00:00
Pratyush Shukla
2d7c5c68fe Update openbb-devtools (#6008)
* update deps

* unpinned package versions from gh linting action

* codespell

* updated black dependency

* linting

* linting

* linting

* pin codespell version

* black

* black again

* install devtools in linting action
2024-01-29 12:21:06 +00:00
Igor Radovanovic
4755711be6 [Feature] - Field order added to the OBBject extra as preference (#5999)
* Disable auto_build on test run

* Add field order to OBBject

* Improvements

* Remove noxfile

* Disable auto_build on test run

* Add field order to OBBject

* Revert

* lint

* Add docs

* Not sure how this happened

* lint
2024-01-29 11:15:21 +00:00
Eric Li
2e0551e845 Fixing Docs Typos (#5955)
* fixed typo

* fixed stocka typo

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2024-01-25 10:08:45 -05:00
Danglewood
03197c9a41 update extension descriptions page (#5985) 2024-01-23 12:02:22 +00:00
Danglewood
e2f7e597fa feature/cboe-async: Refactor Cboe for Async (#5900)
* refactor cboe for async

* codespell

* unused imports

* pylint

* more pylint

* platform metadata

* classmethod decorator

* test params

* intrinio quote

* test param names

* date in test needs to be a datetime.date not string

* make fmp unix timestamp tz-aware and normalize percent change

* different way of parsing datetime string

* recapture cboe equity historical test

* unused import

* index snapshot update

* black

* extension map

* pylint

* cboe pyproject.toml

* proposal to standardize equity_quote

* one more file

* removing changes on static assets

* index_historical

* index_historical again

* last_time -> last_timestamp

* obsolete router path

* fix tests

* test param

* restore market index deprecation that I forgot about

* fixing tests

---------

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
2024-01-22 15:17:42 +00:00
Danglewood
2428d3efe2 docs/http-requests: Contributor Guide For Building HTTP Requests (#5973)
* contributor guide for http requests

* add a docstring

* add section on get_querystring

* extra space

* add note for people installing PyPI in a zsh terminal shell

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
2024-01-20 16:46:25 +00:00
montezdesousa
65bc870be3 move templates (#5970) 2024-01-18 18:36:21 +00:00
montezdesousa
e9ddbd36cf Uppercase excel reference (#5958)
* uppercase reference

* fix name header

* add tab title

* remove reference excel folder

* add to gitignore excel reference files

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2024-01-18 12:10:40 +00:00
minhhoang1023
6fb7860a3e Update to OpenBB Add-in for Excel (#5965) 2024-01-17 11:10:31 +00:00
DidierRLopes
f58380bed9 Excel tutorials on the docs (#5956)
* update workflows name to tutorial

* update title

* get barebones to bring in Excel videos

* tutorial excel videos in
2024-01-16 17:09:35 +00:00
montezdesousa
16cffc5f81 Docs/remove core refs (#5957)
* remove references to core: PathHandler + ProviderInterface

* remove unused function

* add comment

* regenerate

* fix a few examples

* add comment

* rename file
2024-01-15 15:24:20 +00:00
montezdesousa
83aa71a28b Create Excel templates page (#5947)
* create templates page

* Update index.mdx

* fix description

* update card

* remove clsx

* Update index.mdx

* Update index.mdx

* Update index.mdx

* Update index.mdx

* min height

* min height

* improve excel docs and point towards hub

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2024-01-14 02:29:43 +00:00
Danglewood
c0f0445762 docs/data-models-url: Fix URLs on Development Page (#5944)
* fix url to the standard models

* github links
2024-01-12 11:39:37 +00:00
montezdesousa
b1157cda7d Update excel docs (#5940)
* update basics

* update reference generator
2024-01-10 16:59:47 +00:00
montezdesousa
f79f50abbc Docs/bug fix (#5926)
* fix pro link

* fix wrong example
2024-01-08 15:57:30 +00:00
montezdesousa
00febe1942 Docs/excel examples (#5920)
* regen excel md

* add syntax + basic example

* fix example

* create json with docs map

* update docs to latest functions.json + remove tiingo

* remove space from examples

* minor fix

* remove spaces

* remove spaces

* bug fix: remove folder before generating

* fix typo

* add link to appsource

* fix

* Update templates.md

* regenerate content

* change docs colors

* fix light mode

* add back tiingo

* update functions.json

* templates go later

* remove Library from reference

* Make the excel markdown being generated at runtime

* fix reference cards having commands under menu

* remove excel/reference folder since this is built at runtime by gh-pages action

* black formatting

* improve title

* add excel to the main page

* add excel image bg

* make excel sidebar show up next to pro

* improve main page

* small fix for platform page title

* update basics page

* add tip to autocomplete

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2024-01-08 11:53:05 +00:00
Danglewood
70633e37a0 docs/platform-faq: Start Platform FAQ page with bullet points on Platform vs SDK (#5914)
* platform vs sdk faq page

* add data and data providers faq section and some style cards

* typo

* makes changes as per reviews

* openbb-nightly as a way to install everything

* jupyter-lab instead of jupyter

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
2024-01-05 23:17:42 +00:00
DidierRLopes
2bc67f36a4 Update index.md (#5906) 2024-01-03 22:13:38 +00:00
Danglewood
3eaf0d2ef1 docs/legacy-install: Add warning at top of page - Instructions on this page are for installing the Terminal (#5904)
* add warning at top of page - instructions are for installing the Terminal app

* pip install openbb-nightly
2023-12-28 14:14:18 +00:00
montezdesousa
40b53b0db3 Docs/excel update (#5889)
* update xl docs

* update syntax line

* update again
2023-12-18 11:07:41 +00:00
Danglewood
3a12348f3a fix a v3 syntax example (#5891) 2023-12-15 15:14:20 +00:00
Theodore Aptekarev
675480972d Add REST API docs page with advanced settings configuration (#5890)
* Don't mention docker in a list of python envs

* Create a REST API page

* Update docs to get api keys from the hub

* Update installation instructions

* Mention requirement of poetry and toml in source installation section

* move rest page up to the top. and add url to google colab example notebook

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
2023-12-15 15:14:03 +00:00
montezdesousa
40c0c9c20f Excel docs (#5870)
* first test

* remove old reference

* bring this file back

* generate sidebar and write empty mds

* generate index.mdx

* get description from cmd_lib

* fix reference card error

* rename file

* generate markdown

* regen

* add last+hist

* update pages with seo metadata

* format types

* small fix

* css sux

* add usage placeholder

* set hidden by default

* nah

* add cmds and menus to reference

* lint

* fix/Users/diogosousa/opt/anaconda3/envs/platform/bin/python /Users/diogosousa/OpenBB/OpenBBTerminal/website/generate_excel_markdown.py

* format mds

* remove space

* fix commands heading

* redo folder structure

* add back cmd description

* move card to var

* different main folder

* clean

* move vars

* refer to editor

* rename var

* done

* recreate folder structure

* add section: syntax + minor adjustments

* remove return type

* remove return type

* rename api to library

* minor fix

* remove api folder

* remove api folder

* formatting

* improve basics

* basics

* fetch functions.json from website

* complete basic

* change syntax to use semi-colon

* basics

* basics

* remove space in sig

* remove sections

* add metadata

* Update formula builder

* add tabs

* Update index.md

* complete basics and formula_builder

* Update index.md

* add windows screenshots

* restructure folders

* regenerate with latest add-in version

* move Excel sidebar

* rename function and add comment

* now it's working

* logic

* rename folder

* Update formula_builder.md

* fix

* hide excel for now

* some explicit typing

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-12-07 19:41:20 +00:00
Danglewood
17a69d2145 update command syntax (#5867) 2023-12-07 00:27:12 +00:00
Henrique Joaquim
9e7baa76c7 Pointing to the dev section of the docs instead (#5853) 2023-12-04 17:20:43 +00:00
James Maslek
905b7fd9d4 Small change in extensions doc (#5844)
* break one table into 2

* Edit pypi readme

* remove extra ```

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
2023-12-01 20:26:52 +00:00
DidierRLopes
8273a200e8 fix docs (#5847) 2023-12-01 19:20:19 +00:00
Danglewood
c047cfeddd docs/new-working-docs: New working docs branch (#5768)
* move old example notebooks to v3 folder, update loadHistoricalPriceData and add findSymbols

* Create README.md

* Update README.md

* Update README.md

* Update README.md

* Vertical diagram instead

* important classes

* core dependencies

* folder structure

* devtools

* swap order

* fix github pages deploy issue

* development index

* delete expectations for developers

* devtools

* obbject stuff

* add

* installation

* hub sync

* idk if i committed already

* add usage page for financial statements

* add link to reference page

* syntax

* numbers

* nearly --> more than

* easier to read code blocks

* codespell

* removing mention to provider

* add 'orientation' for to_dict

* info card for output user preference

* put it in a code block

* correct user_settings.json example

* syntax corrections

* fix sentence

* get rid of floating point mathc

* get rid of other floating point math

* add companion example notebook for financial statements, and new section

* historical prices usage page

* codespell

* add commitment of traders section to usage

* add a note

* codespell

* get rid of equals sign

* Cleanup docs. with @the-praxs

* install

* obbject extend

* spell

* HeadTitle thingies

* Update obbject_extensions.md

* Update obbject_extensions.md

* typo

* Update architectural_considerations.md

* point to the TET pattern

* optional vs required

* reviewing the  patterns. removed the --pre flag under the assumption this will be the final docs for the release cc @deeleeramone

* add a walkthrough

* spelling

* Add more in the introduction

* validator examples

* update Copper-to-Gold notebook example for V4

* Update README.md

* QA Caveats w @the-praxs

* info on class outputs

* merge add data sources and add data points

* disclaimer on cookiecutter

* add missing import to example

* slight syntax change

* missing code block

* missing import

* update intrinio example syntax

* intrinio syntax update

* urls

* core and provider merged

* example syntax

* grammar

* Update API banner link

* quick-fix-docs cc @minhhoang1023

* Update pip install command for v3

* remove --pre note block

* update landing image

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: Luqman <luqazino@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-12-01 01:09:25 +00:00
DidierRLopes
a96e52de20 Docs/pro new widgets struct (#5805)
* Improve widgets library structure

* add styling to widgets library images

* black linting

* update widgets library index generator

* update border of docs image

* shift grouping Minh suggestion

* no ruff in this file

* Update chart-from-raw-data.md

* lint

* add pro to index docs

* add workflows to docs

* dunno how to spell existent lol

* navbar logo to go to root docs

* push missing bg

* backend for terminal pro repo - Andrew suggestion

* update content slightly

* no widgets-library content should be pushed, this is generated at runtime

* add Rita's vidos + review everything
2023-11-30 00:34:27 +00:00
omahs
c8bc7fe256 Fix typos (#5808)
* fix typo

* fix typos

* fix typo

* fix typos

* fix typos

* fix typos

* fix typo

---------

Co-authored-by: Luqman <luqazino@gmail.com>
Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
2023-11-29 12:03:33 +00:00
DidierRLopes
dd833ffbac Update Pro documentation (#5784)
* fix pro videos to latest ones

* small fix

* attempt border on pro

* Update index.md

* Update index.md

* Update charting.md

* Update homepage.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update index.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update advanced-search.md

* Update copilot.md

* pro images gradient

* update images with border

* Update news.md

* Update news.md

* add examples to platform v4 generation/ fixed data model ref titles

* fix `data_reference_cards` sort by title

* Merge branch 'docs/update-pro-videos' of https://github.com/OpenBB-finance/OpenBBTerminal into docs/update-pro-videos

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-11-24 22:23:16 +00:00
Henrique Joaquim
4400cd9a8f Merge provider and core into core (#5774)
* small changes - moving provider inside the core

* uptade readme

* lint

* remove old provider readme

* leftovers

* refactor website examples

* ruff

* fix nox

* relock

* fix fails_to_deliver headers

* fix for tests that have renamed endpoints

* fix discovery

* removed test for renamed endpoint

* fix broken syntax - test_search_financial_attributes

* fix cash/income/balance

* fix derivatives tests

* fix etf tests

* fix news tests

* fix regulators

* black

* wrong test param

* sort equity gainers/losers by percent

* platform markdown generation import

* Hotfix/fix int tests core merge (#5779)

* removing tests on old endpoint

* removing visualization on old endpoint

* fixing equity tests

* fixing examples

* fix news tests

* fix index test

* example

* add comments

* example

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-11-22 13:48:01 +00:00