Commit Graph

431 Commits

Author SHA1 Message Date
Danglewood
edd45cd3e7 Creates Crypto/Discovery SDK Guide. (#3718)
* Creates Crypto/Discovery SDK Guide.

* moves `crypto.md` into a `/crypto` folder and renames as `index.md`

* makes requested changes

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-12-09 14:12:03 -05:00
Ioannis Kontopoulos
4b13b11f65 Fix typo on Advanced User Install (#3730)
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-12-08 12:18:04 -05:00
Eric Slater
34b5d5a91a adding basic instructions for the --export feature (#3669)
* adding basic instructions for the export feature

As my first contribution I would like to propose adding some additional basic instructions for using the --export feature on this documents page

* Updates this page with some more export/import instructions.

* Linter

* exported for tables --> exported from tables.

* adding !

* adding !, attempt 2

* deleting the .VS file

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-12-06 11:04:42 -05:00
Danglewood
9d9a3e84a2 Creates Trading Hours SDK Guide (#3717)
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-12-06 09:07:35 -05:00
Danglewood
acb15772a2 Updates Stocks Intro Guide for Terminal 2.0 (#3679)
* Updates Stocks Intro Guide for Terminal 2.0

* Makes requested changes.

* missed an ! prefacing the first image.

* Adds a section for accessing sub-menus
2022-12-05 16:25:13 -05:00
Danglewood
72594cad02 Creates Government SDK Intro Guide (#3706)
* Creates Government SDK Intro

No file existed previously, created.

* added exception in linter for an item in a table, OT

* Makes the changes
2022-12-05 16:24:42 -05:00
Danglewood
f68929fa1e Updates Options SDK Intro (#3709)
* Updates Options SDK Intro

* Makes the changes
2022-12-05 16:24:21 -05:00
jose-donato
1e4613a2ed Fix window use on server for docs (#3714)
* feat: fixes on docs website

* fix: navigator fix
2022-12-05 18:21:25 +00:00
jose-donato
389ecc5927 Redirect users to correct installation tab based on OS (#3676)
* feat: fixes on docs website

* fix: tab

* fix: andrew issue

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2022-12-05 15:15:57 +00:00
Chavithra
9add3e60df Docker: update installation instruction (#3692)
* Moving Docker folder into Build

* Workflows : update Docker

* Docker : update compose image version

* Docker : fix volumes path

* Docker: update documentation

* Docker : build.sh add prompt for version number

* Fix spelling

* fix hostname

* adding permissions to folders

* changing version to latest

* reverting wrong change

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
2022-12-05 14:49:31 +01:00
Danglewood
1f54385b3d updates FA SDK Intro (#3681)
* updates FA SDK Intro

* linter

* makes the changes

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2022-12-05 09:48:49 +01:00
Danglewood
18da2e1bda found the typos: they --> the & an instance where overview should be performance (#3682) 2022-12-01 22:03:26 -05:00
Danglewood
db9555efbf Updated the list of functions. so --> sortino (#3668)
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-12-01 14:05:47 +01:00
Danglewood
24ff937e24 Creates Stocks Screener SDK Guide (#3661)
* Creates Stocks Screener SDK Guide

* linter

* linter again

* Updates with requested changes.

Requested changes have been made, and the script has been made more robust as I noticed that when collecting the data during market hours, the time it takes to request the data is enough to create differences in the Price, Change, and Volume columns. Solution was to drop them from four of five dataframe.

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-12-01 12:08:32 +01:00
teh_coderer
2494342d4c [Docs] Fred Autogen fix (#3658)
* Update controller_doc_classes.py

* test gh-actions

* Update gh-pages.yml

* Update generate_terminal_markdown.py

* cleanup generate_terminal_markdown.py, patch binance error preventing generation

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-11-30 20:35:51 -05:00
Chavithra
cb98e1d81e Docker : image build + documentation (#3666)
* Moving Docker folder into Build

* Workflows : update Docker

* Docker : update compose image version

* Docker : fix volumes path

* Docker : image build + doc

* Docker : update image name

* Docker : update build

* Docker : clean cache

* Docker : image name
2022-11-30 09:58:03 -05:00
Jeroen Bouma
27dbc93354 Fix po plots not showing (#3652)
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
2022-11-29 19:32:50 -05:00
andrewkenreich
5b1d7d95c0 docs - links and order (#3649)
* docs - links and order

* few more on sdk side
2022-11-29 09:50:04 -05:00
jose-donato
9fdfca2742 Link fix (#3643)
* fix(docs): added margin between sections

* fix: link

* Update docusaurus.config.js
2022-11-29 12:11:56 +01:00
jose-donato
b181ed3868 New installer buttons links and for docs (#3638) 2022-11-29 00:05:13 -05:00
Chavithra
d825f98fc1 Release 2.0.0 (#3626)
* Moving Docker folder into Build

* Workflows : update Docker

* Docker : update compose image version

* Docker : fix volumes path

* Set version 2.0.0

* Doc : update docker compose file link

* remove hcp (#3627)

* Update dockerfile

* Update docker compose file

* Docker

* Docker compose

* changing setup nsi to correct version

* Update etf/ta

* Fix etf/tv

* Enabling autocompleter on etf/t

* Remove debug mode

* Disable PO detection on SDK (#3637)

* Turn Riskfolio detection off

* Disable reports/forecast

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: James Simmons <simmonsj330@gmail.com>
2022-11-28 21:27:02 -05:00
andrewkenreich
e042116fab Docs part 2 (#3625)
* changes

* fixes 2

* po fixes

* 60-40

* few more fixes on links

* Update docker location

* Fix from basics

* Sorry Andrew

* putting /build in docker

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
2022-11-28 17:19:18 -05:00
andrewkenreich
6381b2ae7d Doc updates and fixes (#3609)
* fixing a url

* moving around menus

* Grammar Update

* many fixes to links and some added pics to install

* Add improvements

* fix: tabs

* Move support/feedback window to FAQ

* Forgot to save

* MVC moved around

* change installation Source -> Python

* fix: tabs

* guides to basics

* Add new README LINKS

* Change links

* Change forecasting to forecast

* fix: details

* more fixes

* Change markdown file so it is ready for pypi

Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
2022-11-28 12:13:47 -05:00
martinb-bb
b1f3dc1bf1 fixing parameters (#3602)
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-11-28 09:27:11 -05:00
Danglewood
24d19030ed Updates SDK Portfolio Guide (#3592)
* Updates SDK Portfolio Guide

* Updates with requested changes.

I think that's all of them.

* URL update

* Table rounded to 2 decimals.

* rest of the tables rounding

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-28 12:17:32 +01:00
Danglewood
25d0e29d7d Updates Terminal FAQ (#3601)
* Updates Terminal FAQ

* linter

* Moved general update instructions to the General section.

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-28 10:19:57 +01:00
Danglewood
536ed9f7a0 Creates Dark Pools and Short Data SDK Guide (#3611)
* Creates Dark Pools and Short Data SDK Guide

* Linter

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2022-11-28 08:53:03 +01:00
Danglewood
4e0f510b91 updated TA SDK guide import block with comment (more copy/paste friendly) (#3595) 2022-11-27 15:01:09 -05:00
Danglewood
fda3b786b4 Adds Stocks/DD SDK Intro Guide (#3598) 2022-11-27 15:00:39 -05:00
jose-donato
2e2e5e2fb6 fix about command (#3532)
* fix(docs): added margin between sections

* fix: about command

* fix: about command to match new docs

* sdk aout

* fix: fix homepage

* fix: features -> reference on generate; about on homepage

* fix: juan magic

* update on merge workflows

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-25 18:42:07 -06:00
teh_coderer
79046608b6 Docs Fix (#3543)
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00
jose-donato
55b1facd1f FIx anchor tags in documentation (#3583)
* feat: fixes on docs website

* fix: fix anchor tags
2022-11-25 17:14:26 -05:00
martinb-bb
e1bba247e2 Forecast docstring fixes and other things (#3564)
* init commit for doc string fixes

* quick fix

* Forecast Guide Draft 1

* grammar

* sentence edit

* missing word

* target column is a string, not a list. ooops

* clarification on default target column

* minor mods

* more fixes

* Fixed dashboard

* val instead of tickerseries

* Added fixes

* $ --> <>

* Fixed pylint

* one quick change

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: colin99d <colin99delahunty@gmail.com>
2022-11-25 17:13:38 -05:00
jose-donato
f1e8482e63 Docs website fixes (#3580)
* feat: fixes on docs website

* fix: added installers to docs, 404 and header

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-11-25 14:50:41 -05:00
montezdesousa
598044ac6a Fix [Bug] SDK - openbb.stocks.dps.vol_exch_chart - Error: 'Date' (#3561)
* remove volexch

* remove volexch from sdk
2022-11-25 14:50:10 -05:00
Jeroen Bouma
6316d36be1 Many improvements to the documentation (#3562)
* Many improvements

* Forgot these

* Set menus correctly

* Delete unrelated code

* Add in chart styling

* Add in simple guide to chart styling

* More updates

* last changes

* Update changing-sources.md

* Update file to redirect to proper folder and formatting

Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: Jeroen Bouma <jeroenbouma@jeroens-mbp.home>
2022-11-25 18:10:28 +00:00
jose-donato
dc9ae37f6a feat: fixes on docs website (#3563)
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-11-25 10:44:06 +00:00
martinb-bb
7c57fb71c5 Fixing Forecast SDK with data from other menus (#3554)
* minor check incase using sdk

* fixes combine

* datetime formating

* Update forecast.md

* fix testing
2022-11-24 11:59:10 -05:00
Danglewood
a4d62fe1ad Fixes some things, and adds an additional example (#3547)
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-24 12:50:15 +01:00
Danglewood
244eaa3d1e edits for pip install openbbterminal[extras] --> pip install openbb[extras] (#3548)
* edits for `pip install openbbterminal[extras]` --> pip install openbb[extras]

* another one

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-24 10:06:32 +01:00
Jeroen Bouma
95431ecb85 Many improvements to the documentation (#3542)
* Many improvements to the documentation

* Remove redundant guides

* details

* Add guide backin

* linting

* Update FAQs

* Match it up with SDK

* add po to sdk

* Add PO in

* adding discovery

* adding BA and FA to sdk

* Add in Troubleshooting page

* quick fix on forecast

* onemore quickie

* fix sdk

* updates to troubleshooting

* Add in ticker to codespel so it doesn't whine

Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: martinb-bb <105685594+martinb-bb@users.noreply.github.com>
Co-authored-by: james <jmaslek11@gmail.com>
2022-11-24 08:27:04 +01:00
Danglewood
e0a08aaf04 Adds missing commands to QA; moves it out of Stocks; to be like TA (#3540)
* Adds missing commands

* Moved out of Stocks to be like TA
2022-11-23 12:33:55 -05:00
James Maslek
649dd1d64b Fix linter issue (#3538)
* Fix linter issue

* Didnt import optimization menu

* Fix some things for deployment

* openbbterminal -> openbb

* openbb
2022-11-22 20:40:44 -05:00
andrewkenreich
a0c5b4946a add changes to docs (#3533)
* add changes

* fix

* change 2

* fix: new folder structure

* fix: jeroen stuff

* fix: grammer

Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-11-22 17:42:44 -05:00
jose-donato
e1962252ad Docs fixes (#3530)
* fix(docs): added margin between sections

* fix: images

* readd old content for examples/images

* fix: codespell

* fix: codespell

* fix: ga

* fix: remove temp lorem ipsum

* fix: docu config for edit page

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 14:56:17 -05:00
Theodore Aptekarev
15d1870194 Reorganize project extras for a pip installable package (#3432)
* Re-solve the dependencies for optimization extras

* Remove unused reportlab helpers

* Update install from source and troubleshooting docs

* Fix typos found by cspell

* Prevent po menu from launching when optimization toolkit not installed

* Add optimization dependencies to default requirements.txt for the CI

* Add optimization toolkit installation to the CI

* Fix markdown linting

* Update CI test dependency installation for matrix tests

* Fix markdown linting

* Update source installation docs

* Clean up ToC in the main readme

* Update the SDK documentation

* Fix markdown linting after making readme sections linkable

* Fix more markdown linting

* Fix more markdown linting

* Update secrets detection with exclusion rules

* Bump detect-secrets configuration

* Tune secret detector

* Fix more markdown linting

* Add optimization toolkit install to installer GH actions

* Add optimization toolkit install to docker build

* Fix typos

* Add "all" extras setting to install torch and riskfolio

* Move forecasting dependencies to pyproject.toml

* Update CI build configs

* Update documentation to feature the "all" extra

* Lint markdown

* Update docs to specify requirement of having a C compiler

* Added log Id to codesigning steps in inteel Macos workflow

* Changed disk for the m1 macos build

* Changed disk for the m1 macos build

* Changed disk for the intel macos build

* taking out sigtool removal line

* Remove dev version number from pyproject.toml

* removing sigtool from all build steps

* changes to m1 build and commenting test_report_economy

* more m1 build changes

* testing exit on conda setup

* some more

* changing shell to bash to setup conda

* bash on lines

* bash on all lines

* small bash removals

* intel fix and test_crypto int test

* upgrading setupminiconda version

* adding back in intel conda init and reset

* intel removal of init

* taking bash back out from m1

* removing old codesign lines

* adding codesign specific binaries

* ssl fix for all terminal

* removing if installer

* various ssl fixes across commands

* fixing ssl mistake

* integration test changes

* Linting + remove comment

* Update poetry.lock

* Update requirements

* Update the docs to mention that PO is not working on arm arch

* Update deps to pin setuptools

* Disable reports on pyinstaller packaged version

* Update reports

* small grammar change for forecast report message

* Pin grpcio following introduced regression in 1.51.0

* Update docs to reflect changes in how optimization is installed

Co-authored-by: Luqman Bello <lb@Luqmans-MacBook-Pro.local>
Co-authored-by: James Simmons <simmonsj330@gmail.com>
Co-authored-by: James Simmons <53658028+simmonsj330@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Chavithra <chavithra@gmail.com>
2022-11-22 12:33:59 -05:00
jose-donato
2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00
jose-donato
eb0c305107 Sdk markdown generation (#3407)
* fix(docs): added margin between sections

* 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

* feat: initial files

* feat: added meta head

* feat: added funcdef

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

* feat: added view and merged with jaun

* Update generate_sdk.py

* Update generate_sdk.py

* Update generate_sdk.py

* Update generate_sdk.py

* init

* fix returns

* fix: random stuff

* fix: random

* fixed encoding issue on windows

* fix: generate tabs

* Added changes

* Added fixes

* Updated dependencies

* Added Jose fixes, pls work

* FIxed small issue

* Automated Change

* Added forecast, will prolly also need to pip install

* Added fix

* Automated Change

* init

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* moved folders out of common into root

* remove cat from trail if sub in [ ba, ta, qa ]

* Update generate_terminal_markdown.py

* un-indented example images

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* replace ✨ with 🦋

* Update regression_model.py

* updates

* up

* Automated Change

* removed Juan sdk

* update

* updates

* fix missing type hints, added defaults to sdk generation

* typing

* typing

* datetime defaults, fix dict_keys([]) in choices

* fix regression docstring, added divider on markdowns

* fix get_hcp portfolio trailmap

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* fix: some more stuff

* fix: bump ga to 3.10

* fix: examples

* fix: removed functions from root and moved ga

* fix: run pages only when main is merged

* fix: new poetry.lock

* Update dependencies

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>
Co-authored-by: colin99d <colin99delahunty@gmail.com>
Co-authored-by: colin99d <colin99d@users.noreply.github.com>
Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-11-22 12:17:35 +01:00
teh_coderer
6c9c6a68ec Terminal Docs Auto Generation (#3438)
* init

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* moved folders out of common into root

* remove cat from trail if sub in [ ba, ta, qa ]

* Update generate_terminal_markdown.py

* un-indented example images

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* replace ✨ with 🦋

* Update regression_model.py

* updates

* up

* fix missing type hints, added defaults to sdk generation

* typing

* typing

* datetime defaults, fix dict_keys([]) in choices

* fix regression docstring, added divider on markdowns

* fix get_hcp portfolio trailmap

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update .gitignore

* Making it more 3.9 friendly

* Update controller_doc_classes.py

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: Chavithra <chavithra@gmail.com>
2022-11-22 00:21:18 +01:00
montezdesousa
570e579067 Portfolio docstring example fixes and some bugs (#3431)
* fix doctest

* fix some type hints

* reorganize portfolio folders

* fix rfr

* fix vol bug

* fix more docs

* fix failing test

* doc typo

* numpy fix

* pydocstyle

* regenerate website docs
2022-11-18 19:30:55 +00:00