Commit Graph

105 Commits

Author SHA1 Message Date
Danglewood
42bf98d6a4 hotfix/options-chains-guide: Adds SDK intro guide for Options Chains (#5155)
* add SDK intro guide for options chains

* add screenshots to page
2023-06-20 12:52:52 +00:00
Danglewood
ae452852d7 adds debug mode instructions for terminal and sdk (#5145) 2023-06-15 21:48:49 +00:00
Danglewood
e202aeb557 Hotfix/docs-sdk-basics: Updates SDK basics page. (#5024)
* updates SDK basics guide - images to follow

* adds images

* spelling

* add sentence for token regeneration

* consolidates changing sources page with the basics page

* consolidate chart-stylying guide with basics

* api-keys pages

* adds Stocks Insiders intro to SDK docs

* typo

* add cloud installation

* syntax error

* no cloud installation instructions

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-05-23 20:20:29 +00:00
Danglewood
72c4ce01f3 Updates SDK Intro Guide for Fundamental Analysis Module's Recent Changes (#4964)
* Updates SDK intro guide for fundamental analysis for recent changes

* previous commit was missing this

* fixes

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-05-04 17:32:27 +00:00
northern-64bit
5e92dbe636 Fix error in the SDK portfolio intro documentation (#4945) 2023-05-01 20:41:23 +00:00
Theodore Aptekarev
18204202ac Remove stocks/disc/cnews command (#4920)
* Remove stocks/disc/cnews command from terminal and sdk

* Remove disc/cnews tests and test data

* Remove cnews from default sources, translations and intros

* Remove old test data files that are not used anymore

* Add pydocstyle ignore statement to pyproject toml

* Fix print help in stocks/disc controller test
2023-04-27 16:24:13 +00:00
James Maslek
bcb9129c8a showcase 2023-04-25 13:04:37 -04:00
Jerry Duluk
f21d25436b Improved SEO of OpenBB Docs (#4774)
* Small typo

* Updated SEO for OpenBB Bot Docs

* Updated SEO for all SDK docs pages

* Updated all SEO for OpenBB Terminal Docs pages. Plus grammar edits

* Updated spelling edits for SDK and Terminal

* fix: headtitle component

* Updated Page titles for SDK and Terminal FAQ pages

* Updated page titles for all SDK docs pages

* Updated page titles for all Terminal Docs Pages (not reference pages)

* Updated page titles for Bot (not reference pages)

* Add | OpenBB Docs title for SDK and Terminal (#4883)

* add Terminal | OpenBB Docs

* SDK | OpenBB Docs added

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
2023-04-25 13:58:58 +00:00
jose-donato
d22cdb64d5 Replaces cloudflare bacon with posthog for docs + docs fixes (#4843)
* feat: replaces cloudflare bacon with posthog

* fix: posthog apikey

* fix: new keys

* fix: added feature flags
2023-04-21 18:25:55 +00:00
Danglewood
af800613c8 Hotfix/docs - Some Intros Updates. (#4777)
* removes .ini from screener preset examples

* updates sdk economy intro

* Update economy intro guide screenshot

Swaps screenshot with new chart

* updates terminal stocks intro

* updates screenshots for stocks intro
2023-04-14 07:34:09 +00:00
martinb-bb
8397a990c9 URL(404) fixes for multiple locations (#4738)
* URL fixes

* docker url
2023-04-11 18:06:49 +00:00
Danglewood
8b30f1a117 Hotfix/stock screener - Stock Screener Fixes (#4674)
* stock screener fixes

* improves error message, this is a FinViz preset

* removes non-screener functions from screener menu

* ruff

* removes tests for removed non-screener functions

* updates tests

* black

* ruff

* adds s&p 500 sector presets

* updates Terminal intro guide for stock screener

* Update screener.md

Updates guide with screenshots.

* Update screener.md

spelling

* updates SDK Intro Guide for Stock Screener

* pylint disable=too-many-lines --> disable=C0302

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
2023-04-08 20:19:04 +00:00
DidierRLopes
2754be2620 Improve overall docusaurus (#4675)
* Improve overall docusaurus

* update pypi on installation

* fix merge conflicts

* fix spelling

* change CRLF to LF

* improve docs installation for bot

* more changes

* few more

* fix

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-04-07 01:50:45 +00:00
andrewkenreich
c87226e9b6 hotfix/fixing some links (#4628)
* fixing some links

* adding pypi to installation

* fixing order
2023-04-04 06:11:16 +00:00
Theodore Aptekarev
417769c4cc Improve installation experience and documentation (#4508)
* hi didier

* Add files

* Include build deps and third-party binaries in conda env files

* Add the changelogs from GH

* Api keys + cleaning up spelling + found some old refs

* spelling

* Merge branch 'feature/documentation3p0' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/documentation3p0

* updates to faq sections

* spelling

* fixing FA so it runs

* adding guides - need pics

* Add gcc and maturin to build dependencies

* telegram/discord docs markdown format conversion

* Remove gcc from conda env files

* Update install from source guide for terminal

* fix: added new reference styles

* adding examples to discord - remove play button

* updating bot docs

* Update SDK installation docs

* Bump datetime package in lock file because current version was yanked

* Update requirements txts

* Remove rust tools from main conda env

* Pin poetry to 1.4.0 because of a regression in 1.4.1

* Bump version of lightgbm to 3.3.5

* Address formatting and minor content comments

* Advise all users to clean up conda artifacts with scripts

* Add placeholder for pywry related docs

* Update requirements.txt

* Downgrade statsforecast to prevent pulling jupyter-dash

* Add catboost to conda dependencies for windows install to work

* Add charset-normalizer to conda deps because of a buggy windows build

* Add xgboost to conda deps because of a buggy windows build

* working!!

* 3.8 and 3.9 xgboost

* spelling

* Point sdk install from source to terminal source install

* image showing on docs

Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>

* feat: added imageurl for examples

* updates Stocks SDK intro

* bot pics update

* Bump python version on macOS CI builds

* updating rest of bot docs

* Move charset-normalizer to the pip section of environment yamls

* Update mac CI workflows to use the correct cache

* Move poetry to pip section of the conda yamls

* Fix typo in file path

* Fix direct_url.json files not being deleted on the CI

* Fool reviewpad

* Actually fool reviewpad

* adding code for generating index and bot updates

* linting

* add commands for GTK on linux

* Update deps after conflicts and CRLF line endings made it into develop

* test bump down for matplotlib

* codesign more dylibs

* intel workflow

* Add signing stuff that failed to intel

* M1 file now

* Remove duplicate lines from codesigning section of build instructions

* Downgrade matplotlib to 3.7.0 to mitigate windows error

* Downgrade python to 3.9 in attempt to fix scipy not packaging correctly

* Downgrade python 3.9 to resolve conflicts found by conda

* Remove duplicate xgboost references

* Downgrade scikit-learn to avoid DistanceMetric32 not being found

* Remove site-packages from bundle following python 3.10 -> 3.9

* Downgrade scikit-learn to avoid DistanceMetric32 not being found

* Fix english in source installation

* Revert advised python to 3.9

* Update SDK installation docs

* Fix typo

* Update lock file hash

* Consolidate all installation instructions in the terminal section

* Add --no-cache-dir to pip calls

* Fool reviewpad

* Remove reference of the conda cleanup from the pypi install

* Fetch the environment yaml directly from the repo without downloading it

* Add rosetta, cpp build tools and libomp as top level requirements

* Update installation links in repo readme

* adds brew install libomp to FAQ section

* fix typo from my updatet

* Capitalization of Section Headers

* puts PyPi toolkit install in quotes, necessary for a non-bash shell.

* grammar fixes

* update docker windows instructions

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2023-03-29 17:53:35 +00:00
teh_coderer
401a78278d Interactive Charts Improvements (#4586)
* ship it

* edits to bot docs

* Update generate_sdk_markdown.py

* splitting installation

* Update plotly.html

* no pywry print if using sdk

* Update popups.js

* Update plotly.html

* Update popups.js

* update bot index.mdx's, ramenize generate_index.py

* remove older index.md files

* added logic for light themes, refactor `generate_sdk_markdown.py` for reference cards

* reshow modebar

* Update plotly_helper.py

* fix reset reloading of env files

* refactor doc generation files

* Update plotly_helper.py

* cleanup

* Update generate_sdk_markdown.py

* Update plotly_helper.py

* updates

* fix csv_columns select overflow

* for james with love

* remove division `/ 1000`  from options_view

* Update backend.py

* Update popups.js

* csv plot candlestick logic for same Yaxis

* Update plotly_helper.py

* Update plotly.html

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-03-27 22:04:41 +00:00
James Maslek
69694332e6 Documentation push (#4501)
* hi didier

* Add files

* Add the changelogs from GH

* Api keys + cleaning up spelling + found some old refs

* spelling

* Merge branch 'feature/documentation3p0' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/documentation3p0

* updates to faq sections

* spelling

* fixing FA so it runs

* adding guides - need pics

* telegram/discord docs markdown format conversion

* fix: added new reference styles

* adding examples to discord - remove play button

* updating bot docs

* image showing on docs

Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>

* feat: added imageurl for examples

* updates Stocks SDK intro

* bot pics update

* updating rest of bot docs

* adding code for generating index and bot updates

* linting

* Downgrade scikit-learn to avoid DistanceMetric32 not being found

* add some updates to guide for auto select commands

* Add pytest-recorder to requirements.txt

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2023-03-23 17:36:47 +00:00
jose-donato
6e9fefce9e Adds bot documentation to docusaurus and changes for hub (#4409)
* feat: adds bot docs to docu

* fix: file structure

* fix: brings changelog and switch platform button

* adding available options and changing Example text

* fix: detect whether iframe, fix availableoptions component, dynamic update third friday for options component

* fix: updated readme to reflect new changes

* fix: made it so from iframe only shows relevant sidebar

* PLAY BUTTON WOOO - works on discord/charting/chart

* comment

* fix: search bar, improve search

* fix: hijacks ctrl+k from iframe, adds visit to hub link

* about

* setting up play button for all images on Discord

* Bot docs updates

* terminal/faqs

* update main page

* add changelog to terminal

* SDK refactoring

* minor reordering

* bot struct in place

* move bot faqs over

* updating bot index and installation

* add new letterings

* fix: adds new navbar

* fix: new bot images and layouts

* updating installation and flow

* black linter

* spelling

* spelling

* The best commit

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-16 16:29:57 +00:00
Jeroen Bouma
452ecd1275 Make adjustments to the guides (#4477)
* Update the website guides

* Fix wrong paths in about functionality

* Update settings and feature flags menu

* Done

* Done

* Update screen
2023-03-14 20:07:35 +00:00
jose-donato
9211a8595c Update documentation with more detailed installation instructions, requirements and more (#4382)
* fix: changed button styles

* Make Rosetta requirements more clear

* Update installation instructions

* Add seperation

* Update windows.md

* Update installation docs

* fix country choices (#4403)

* Hotfix/plotsbackend start (#4404)

* readd removed plots_backend().start() from merged PR

* Update backend.py

---------

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

* Update helper_classes.py (#4378)

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* Add improvements to the website

* Fix keys wrong redirect

* Update installation

* Update requirements

* move things around

* Restructure everything

* Details

* fix: mac issue and redirect installation

* fix: mac macos

* Remove installation .md and make it dropdown

* Update installation of SDK

* Grammar

---------

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-09 17:05:10 +00:00
Jeroen Bouma
87cea82808 Improve stocks/fa/enterprise, now stocks/fa/mktcap, functionality (#4424)
* Improve enterprise, now mktcap, functionality

* Update the scripts to work better with SDK

* Update the tests'

* Update integration tests

* Change SDK

* Spellings

* one more spelling

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-08 20:47:13 +00:00
Danglewood
8e7951f550 puts pip install openbb[all] inside quotes (#4366)
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-01 12:30:56 -05:00
Danglewood
e75309f95f makes requested changes 2023-02-28 10:50:48 -08:00
Danglewood
e45eb3402b adds images for Databento 2023-02-28 10:19:40 -08:00
Danglewood
2925e11ec7 adds clickable URL in keys + Databento 2023-02-28 10:12:01 -08:00
James Maslek
ffe06463fc Merge branch 'develop' into feature/docs-intros-updates 2023-02-27 15:54:18 -05:00
Danglewood
b7ccef7207 fix build failure 2023-02-27 11:11:17 -08:00
Jeroen Bouma
bec294b92d Merge branch 'develop' into feature/finance-database-update 2023-02-25 14:24:18 +01:00
Danglewood
db25cc554c rename sdk faq to troubleshooting 2023-02-24 11:07:03 -08:00
Danglewood
a2bb5eae75 Merge branch 'develop' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/docs-intros-updates 2023-02-24 10:22:19 -08:00
jeroen
a9a27b6806 Delete SIA from OpenBB Docs and SDK 2023-02-24 11:23:57 +01:00
jeroen
cd7806bff6 Fix website not working 2023-02-24 10:38:50 +01:00
jeroen
ef3bf6525d Add intro guides to Fixed Income 2023-02-24 10:30:42 +01:00
Danglewood
453e547fc1 updates to requirements files 2023-02-23 14:20:54 -08:00
Danglewood
c92e805ae4 updates SDK install instructions 2023-02-21 11:22:25 -08:00
Danglewood
05f5b1e38a merge develop into docs-intros-updates 2023-02-17 18:18:10 -08:00
teh_coderer
96af407585 SDK Added about() for methods and class, fixed pypi.md (#4273)
* added log_if_login and about() for methods and class, fix pypi.md

* Update sdk_helpers.py

* mypy
2023-02-17 11:29:07 -05:00
James Maslek
15d8d4556e Merge branch 'develop' into feature/docs-intros-updates 2023-02-16 09:19:44 -05:00
DidierRLopes
2130dea530 Feature/improve docs (#4260)
* Update README.md

* Update README.md

* Create pipy.md

* Rename pipy.md to pypi.md

* Update README.md

* Update pyproject.toml

* Update README.md

* Update README.md

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-02-16 12:02:17 +01:00
Danglewood
d2af156a11 merging develop branch into feature/docs-intros-updates 2023-02-15 15:41:48 -08:00
Danglewood
e5f686f1a3 Flipside Crypto URL correction 2023-02-15 15:00:47 -08:00
Danglewood
461af33b17 adds the screenshot for Intrinio 2023-02-15 14:55:07 -08:00
Danglewood
c29a3f65f8 Typo correction 2023-02-15 14:52:37 -08:00
Danglewood
a887c7fd10 Updates API keys guides and moves them to Getting Started 2023-02-15 14:39:01 -08:00
teh_coderer
69b4d117fa SDK Auto-Generation/Refactor (#3358)
* Fixes

* Update stocks_helper.py

* update git-actions set-output to new format

* Update stocks_helper.py

* Update terminal_helper.py

* removed LineAnnotateDrawer from qa_view

* lint

* few changes

* updates

* sdk auto gen modules done

* Update stocks_helper.py

* updates to changed imports, and remove first sdk_modules

* Update generate_sdk.py

* Update generate_sdk.py

* pylint

* revert stocks_helper

* Update generate_sdk.py

* Update sdk.py

* Update generate_sdk.py

* full auto generation, added sdk.py/controllers creation

* missed enable forecasting

* added running black in subprocess after sdk files generation completes

* removed deleted sdk_arg_logger

* comment out tests

* property doc fix

* clean up

* Update generate_sdk.py

* make trailmap classes useable for doc generation

* Update generate_sdk.py

* added lineon to trailmap class for linking to func in markdown

* changed lineon to dict

* added full_path to trailmap for linking in docs

* updated portfolio

* added func_def to trailmap attributes for markdown in docs, added missing type hints to covid functions

* Update generate_sdk.py

* Update generate_sdk.py

* Update generate_sdk.py

* Update generate_sdk.py

* merge

* update sdk

* updates

* Update generate_sdk.py

* Update generate_sdk.py

* dead imports

* bump

* updates

* updates

* updated missing

* added alt realestate functions to trailmap, logic to clear folders before building

* Update __init__.py

* Update generate_sdk.py

* clean __init__.py files before build

* sync website content folder

* Update generate_sdk.py

* updates + logging

* drop pandas inplace.  add docstrings

* Update trail_map.py

* Update generate_sdk.py

* Update trail_map.py

* stocks/fa PR added

* synced trailmap with develop branch

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update sdk_init.py

* fix removed keys functions

* updates

* reqs txt files

* forgot to save

* up to date with main

* made sure help(openbb.trailmap) is preserved

* ruff

* Update requirements-full.txt

---------

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Chavithra <chavithra@gmail.com>
2023-02-15 14:37:44 -05:00
James Maslek
2a7ec56000 Sunset some dependencies (#4215)
* Sunset some dependencies

* Mypy

* Last iex refs

* remove ref to investpy

* tests

---------

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
2023-02-13 08:54:54 -05:00
Joseph Walker
a11810ac74 Remove export to file now that we are returning a dataframe. Always return a dataframe even if empty. Update tests to reflect removed function arguments. Update documentation as well. 2023-02-10 13:26:08 -05:00
James Maslek
5c2cbf239f Merge branch 'develop' into feature/search-return-df 2023-02-10 12:26:45 -05:00
Joseph Walker
d0d1eb8e28 Remove erroneous extra line from documentation 2023-02-10 11:54:09 -05:00
James Maslek
06d737f4be Adding intrinio and cleaning up options a bit more (#4127)
* Add intrinio load functions into stocks and options.  First try at options sdk with intrinio

* Add a new eodchain function + add intrinio model test

* Unit tests for intrinio options

* dont add eodchain yet -- wait for other PR

* Make null handling better + add intrinio sdk to reqs

* mock dates

* update test

* fix ruff

* black and gitignore

* Clean up and make options load class

* Clean up clean up

* Fix intrinio stock load

* Get requirements even

* sort intrinio chain and fix

* Dont rename the candle input argument

* Fix bug #4060

* Historical option prices

* Add grhist from intrinio and isort

* Fix things for presentation

* Fix tradier chain printing

* YahooFInance chain cleanup

* standardize nasdaq

* Format intrinio

* Cleanup SDK

* Fix tests

* mypy

* Clean up trail map and edit docs

* Fix mapping of info on sdk

* Add intrinio to deps

* Add a rich progress bar to expirations :)

* controller test

* Silly error + tests

* Required arg

* bad assert statememts

* Mutable default

* Keys and switch another tqdm

* BizIns Tests

* tests

* Last Test
2023-02-10 16:54:05 +00:00