Files
OpenBB/website/content/sdk/installation.md
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

819 B
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Installation 1 The OpenBB SDK provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine.
installation
installer
install
guide
mac
windows
linux
python
github
macos
how to
explanation
openbb
sdk
api
pip
pypi

The OpenBB SDK provides programmatic access to all Terminal functions and much more. This layer of code allows users to build their own tools and applications on top of the existing architecture.

:::note The OpenBB SDK is a part of the OpenBB Terminal available from source code and PyPI. Please refer to the installation instructions here. :::