Commit Graph

210 Commits

Author SHA1 Message Date
Danglewood
1d505577c4 Google Colab Install Notebook (#5841)
* Google Colab Install Notebook

Adds example notebook for Google Colab install.

* Update README.md

* Update README.md

Add badge -- won't work until merged into develop

* point to develop for nb

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-12-01 20:27:07 +00:00
DidierRLopes
b4db72f5e8 Update README.md (#5598) 2023-10-23 20:08:07 -04:00
DidierRLopes
3a341f9527 Improve readme header (#5432)
* Improve readme header

* Update README.md

* Update README.md

* Update README.md
2023-09-12 20:52:43 +00:00
DidierRLopes
f822b0afa3 Update README.md 2023-08-12 17:48:36 -07:00
Jinto Jose
19d1a9a067 Vscode/Github Codespaces dev container (#4975)
* vscode/Github Codespaces dev container

* move badge to new line

* actually move badge to new line

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-06-09 13:44:58 +00:00
Pratyush Shukla
3d7b934d16 Fixed incorrect data display using stocks/fa/est command (#4940)
* Removed empty row in OpenBB SDK table under Installation

* Revamped `get_estimates` function

* Linting

* Fixed bugs, tests and modified args

* Fixed test
2023-05-01 20:23:59 +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
andrewkenreich
82d31c169e Update Dev readme (#4600) 2023-03-27 15:09:59 +00:00
Jeroen Bouma
e43b561f84 Update so that image links to website 2023-02-24 13:48:22 +01:00
jose-donato
6de733e607 Small typos on readme (#4267)
small typos

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-02-17 08:25:54 -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
jose-donato
2939b1c4e8 Fixed failing badge not used anymore (#3932)
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-01-13 16:52:26 -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
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
Jeroen Bouma
7bae873084 Tidy up information regarding installation (#3040)
* Tidy up information regarding installation

* Linting is whining
2022-10-27 10:50:04 +02:00
Henrique Joaquim
b2b218c6f7 Fix broken URL for SDK_README.md (#3015) 2022-10-24 14:52:46 +02:00
Chavithra
eb244a1d8d Docker : building + publishing (#2904)
* fixed integrated test test_stocks_ba.openbb

* fixed integrated test test_stocks_dd.openbb

* improved and centralised the check

* fix lint

* Docker : update ci + build files

* Docker : update build and CD

* Docker : update CD

* Docker : test

* Docker : test CD

* Docker : test CD

* Docker : rename `build.sh`

* Docker : tests CD

* Docker : test CD

* Docker : update CD + build

* Docker : fix CD

* Docker : fix CD

* Docker : build

* Docker : test CD

* Docker : CD

* Docker : CD

* Docker : test

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : build + CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : build

* Docker : test CD

* Docker : build + cd

* Moving `scripts`

* Checkout `helper_funcs.py` from main

* Docker : remove test file with alpine

* fixing readme errors

* fixing missed readme errors

* Docker : build

* Logging : handle docker app name

* Docker : test CD

* Docker : cd

* Doc

* Doc

* Doc : linting

* Doc

* Docker

* Doc

* Fixing `terminal_controller`

* Linting

* Doc : fixing links

* Version 1.9.1

* Docker : fix name

* Doc : add volumes in command

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: James Simmons <simmonsj330@gmail.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-10-19 18:00:59 +02:00
Colin Delahunty
e126ad4e42 Sunsets the web_ui folder (#2879)
* Remove web_ui

* Removed some unused stuff

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-10-17 17:24:34 -04:00
Colin Delahunty
f03af510a3 Semantics (#2872) 2022-10-17 14:29:59 +02:00
DidierRLopes
1f85ae2b70 Refactor CONTRIBUTING GUIDELINES (#2494)
* minor improvement

* improve README

* Small improv here

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* improving contributing document

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* test changes

* structure

* line break

* fix structure

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update README.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Contributing Guidelines : updating tests part to link the tests documentation + adding part about logging

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: montezdesousa <montezdesousa@gmail.com>
Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-26 21:56:50 +01:00
jose-donato
8216e8581f Update README.md (#2581) 2022-09-21 10:05:17 +01:00
DidierRLopes
8940297289 Improve readme (#2465)
* improve readme

* improve a bit more

* and a bit more

* linter
2022-08-30 10:51:45 +01:00
James Maslek
be8fa2ee9b Readme update (#2427) 2022-08-26 10:39:35 -04:00
Yahya SayadArbabi
17e7e6bab7 Fix demo video width (#2126)
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2022-07-22 10:42:09 +01:00
pftp-jz
88c091b204 Updating README.md from top folder, CONTRIBUTING.md wrong link (#2075)
The 'OpenBB-finance/OpenBBTerminal' repository doesn't contain the 'openbb_terminal/CONTRIBUTING.md' path in 'main'.

CONTRIBUTING.md link was pointed to openbb_terminal folder, when it was supposed to be pointed to the main folder
Also both are pointing to master folder, and they are being redirected via "Branch not found, redirected to default branch." :
        Maybe update to https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md ?
but either way https://github.com/OpenBB-finance/OpenBBTerminal/tree/master/CONTRIBUTING.md would still redirect correctly
2022-07-12 21:13:37 -04:00
Jeroen Bouma
8324f739b6 Add in a new GIF that better demonstrates the terminal (#2010)
* Add new GiF

* Get rid of the old gif

* Add in new GIF

* Update README.md

* Update README.md
2022-06-29 11:50:02 +01:00
James Maslek
170bdaaf82 Make documentation link front and center in readme (#1895) 2022-06-03 12:14:42 -04:00
Jeroen Bouma
6c70cdc9b7 A lot of improvements to the Hugo documentation (#1893)
* More text, fixed links, added common menu

* Add in bunch of filler text

* Found another broken link

* Get rid of old content

* Push small changes

* Update installation instructions

* Small tweaks

* More adjustments
2022-06-03 10:22:40 -04:00
Jeroen Bouma
f7f16b2597 Add in Portfolio Optimization, Dark Pools, Discovery and Comparison Guides (#1887)
* commit

* commit

* Corrected typo in the index list, and added Thailand, Philippines, Wilshire US Large Cap Growth and Value, MOVE Index

* update to index list

* commit

* commit

* Corrected typo in the index list, and added Thailand, Philippines, Wilshire US Large Cap Growth and Value, MOVE Index

* guides: behavioural anaylsis & trading hours

* linter

* Add in Portfolio Optimization, Dark Pools, Discovery and Comparison Guides

* Update _index.md

* Update _index.md

* Update _index.md

* Remove images

* Some small improvements

* Update _index.md

* Add GIF

* ABC

* Add files via upload

* Fix small mistake

* Remove installer explanation since it is better documented in Hugo

* Small fix

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: didierlopes.eth <dro.lopes@campus.fct.unl.pt>
Co-authored-by: james <jmaslek11@gmail.com>
2022-05-31 18:20:12 +01:00
didierlopes.eth
707fd8f506 Terminal supporting controller with multiple languages (#1730)
* initial implementation of terminal supporting multiple languages

* improve quote command

* stocks controller with english translation pattern

* add language to settings

* update reqs to have python-i18n

* find languages automatically

* add to documentation how to support another language

* markdown

* fix no member issue

* fix test

* refactor code with translations

* translate for options and options/scr

* solve translation for all submenus within options controller

* fix stocks controller tests

* translate disc and th

* dps and sia menus

* scr and ins

* add gov controller

* fix tests for new controllers

* stocks/ba and stocks/ca menus

* add stocks/fa

* res controller

* stocks/dd

* stocks/bt

* qa and pred

* crypto and crypto/disc

* overview and onchain menus

* defi

* nft and tools

* crpyto/dd

* stocks and crypto TA

* finish crypto menu

* finish ETF controller

* finish economy menu

* forex

* alternative and mutual funds

* refactor source for translated version

* econometrics and portfolio and brokers

* portfolio

* fix tests

* finish language implementation

* refactor code for cmds

* improve keys

* refactor name funcs and add docstrings

* fix minor stuff

* fix tests

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-05-24 21:56:16 +01:00
JJ
a30b6daba6 Update README - Very minor grammatical typos (#1792) 2022-05-10 20:27:53 -04:00
Artem Veremey
99e070d325 Updating advanced docker documentation to reference the new container (#1655)
* Updating advanced docker documentation to reference the new container

* Fixing list
2022-04-07 14:19:10 -07:00
didierlopes.eth
5cc2ee9e14 add star history (#1619) 2022-04-03 09:14:02 +02:00
Mabel Oza
870a4a3071 chore: updated the readme, removed the use of the slang Karen and Gan… (#1606)
* chore: updated the readme, removed the use of the slang Karen and Gang, using these words lightly diminishes the weight of harm it caused minorities in the past

* Update README.md

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-04-01 16:19:16 -04:00
Jeroen Bouma
938d987855 Re-add installer README after name change (#1586)
* Re-add installer README after name change

* New image and move legacy images

* Update Twitter handle

* Change Gamestonk to OpenBB

* Add download links
2022-03-29 19:27:08 +03:00
jmaslek
b71abcfbf4 Updating some names (#1575)
* quick econ fix

* black

* keys and feature flags

* terminal name 👀

* some more replacements

* some more replacements

* edit pyproject

* gst -> openbb

* add example portfolios back to git

* Update api from gst

* sorry.  skipping some tests

* another round of names

* another round of test edits

* Missed some .gst refs and update timezone

* water mark stuff

* Fixing Names in terminal.spec and name of GTFF_DEFAULTS to OBBFF_DEFAULTS

* fix more GST to OpenBB Terminal

* Logging : merge conflicts with main

* Revert wrong files

Co-authored-by: Andrew <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-03-29 09:46:26 -04:00
Jeroen Bouma
644095bbc6 Update README files to reflect new installation method (#1551)
* Add Installation process + new GIF

* Add in user-friendly API Keys documentation

* Grammar

* Testing Markdown hook?

* Ain't working apparently

* Add Markdown linting fix

* Change malicious software message

* Add Markdown linting fix

* Add in Installation menu into the main README.md

* Small fix

* Is this the fix?

* Work.

* Found it

Co-authored-by: jmaslek <jmaslek11@gmail.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-03-28 00:34:06 +01:00
didierlopes.eth
bb1f30407d Documentation (#1436)
* add gst letters only

* fix silly mistake with typo on Finnhub

* improve README
2022-03-05 22:46:45 +00:00
didierlopes.eth
2b839f609f Add demo and remove roadmap (#1434)
* add gst letters only

* this roadmap was very misleading

* Update README.md

* Update README.md

* have bot toc closed by default
2022-03-04 01:01:10 +00:00
Arjun V
74f028ddb1 Add web UI for Gamestonk Terminal (#1251)
* Add web version of Gamestonk Terminal

* Update README.md

* Update README.md

* Fix typos, improve formatting

* Add trailing newline to index.html

* Split up long line

* Add comments to launch script

* Update README.md

Co-authored-by: didierlopes.eth <dro.lopes@campus.fct.unl.pt>
Co-authored-by: Chavithra <chavithra@gmail.com>
2022-01-24 02:44:36 +00:00
Steven Soloway
0ed3708179 Fixes issue #1195 (#1199)
Co-authored-by: didierlopes.eth <dro.lopes@campus.fct.unl.pt>
2022-01-17 23:19:09 +00:00
jose-donato
b8d6a51fdd Added installation docs section (WSL) (#1166)
* added wsl docs

* fixed linting

* fixed linting
2022-01-09 16:36:55 +00:00
Didier Rodrigues Lopes
f2df70de4f Update README (#1154)
* Update README.md

* fix md lint in README

* remove line length

* remove line length

* increase md line length

* scrap new and improved
2022-01-07 16:22:24 +00:00
jose-donato
f3838d7581 update hyperlinks in readme (#1098)
* update hyperlinks

* fix hyperlinks
2021-12-25 16:55:13 +00:00
jp
072c413ac0 Bitquery feature branch (#1016)
* Add separate view for finbrain for crypto curreny sentiment analysis

* Move json with symbols to separate directory, little refactoring, update readme

* Add screenshot of finbrain for PolkaDot

* Add bitquery model and view

* Move bitquery to onchain module

* Bitquery added to onchain controller

* Apply long number formatting for big numbers in bitquery commands

* Update README with bitquery API key

* Add error handling for cases when there is no token found, or dextrades response is empty. Use os library to take care of paths to files

* Add helper method to extract dexTrades object from bitquery response. Add timout exception to request function. Add mapping for DECENTRALIZED_EXCHANGES to support lowercase choices:

* Refactor bitquery model and views, prettify column names, remove redundant columns, change command names. Add test for api key

* Update website docs for bitquery

* Add difflib implementation for exchanges in bitquery ttcp command

* Remove menu() from code

* Remove tokens with less than 3 trades (doesn't make sense to show them, as most of them are scams). Add difflib for -coin parameter in baas command
2021-12-09 23:52:58 +00:00
jose-donato
92ff4f9638 Adds commands for crypto withdrawal fees (#1028)
* docs: added missing api docs to readme

* feat: added withdrawal fees commands

* fix: linting

* fix: merged wfc and wfcstats commands

* fix: changes top default to 10, fixes coin name and menu

* feat: added auto completion and minor fixes

* feat: no need for -c flag in wfpe command
2021-12-08 23:34:40 +00:00
Theodore Aptekarev
7dcc9115c4 Add documentation badge to the readme (#1015) 2021-12-04 18:45:19 +00:00
jp
c045b04853 Cryptopanic (#969)
* Add separate view for finbrain for crypto curreny sentiment analysis

* Move json with symbols to separate directory, little refactoring, update readme

* Add screenshot of finbrain for PolkaDot

* Add model for cryptopanic - news aggregator for crypto

* Add view for cryptopanic

* controller for overview

* Add docs for news cryptopanic cmd

* update readme with Coinpanic api key

* add news to hugo main.yml, change export method
2021-11-23 10:38:58 -05:00
Artem Veremey
1d75ea572a Minor style and spelling fixes (#890) 2021-10-31 23:24:21 -07:00
Artem Veremey
ee55b271e8 Enable codespell for markdown and reduce exceptions (#885)
* Enable codespell for markdown and reduce exceptions

* Add a line break

* Spell out categories further
2021-10-31 01:14:22 -07:00