jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve installation experience and documentation (#4508)

Browse Source 
* 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>
This commit is contained in:
Theodore Aptekarev
2023-03-29 19:53:35 +02:00
committed by GitHub
parent 30ca6c69e0
commit 417769c4cc
20 changed files with 11029 additions and 10743 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md vendored
View File

@@ -73,12 +73,14 @@ If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of
|:-|:-|
|[Windows Installer](https://docs.openbb.co/terminal/installation/windows)|Recommended way for Windows if you just want to use the OpenBB Terminal|
|[MacOS Installer](https://docs.openbb.co/terminal/installation/macos)|Recommended way for MacOS if you just want to use the OpenBB Terminal|
|[Source](https://docs.openbb.co/terminal/installation/source)|If you wish to contribute to the development of the OpenBB Terminal|
|[Docker](https://docs.openbb.co/terminal/installation/docker)|An alternative way if you just want to use the OpenBB Terminal|
|[Python](https://docs.openbb.co/terminal/installation/source)|If you wish to contribute to the development of the OpenBB Terminal|
|**OpenBB SDK** &nbsp; &nbsp; &nbsp; &nbsp; |**Usage**|
|:-|:-|
|[SDK Installation](https://docs.openbb.co/sdk/installation)|Recommended way if you just want to use the OpenBB SDK|
|[PyPI](https://docs.openbb.co/terminal/installation/pypi)|If you wish to use the OpenBB SDK in Python or Jupyter Notebooks|
|[Source](https://docs.openbb.co/terminal/installation/source)|If you wish to contribute to the development of the OpenBB Terminal|
nbsp;|
## 2. Contributing