Hotfix/docs-sdk-basics: Updates SDK basics page. #5024
Conversation
deeleeramone
added
docs
…nance/OpenBBTerminal into hotfix/docs-sdk-basics
|
@jmaslek - I removed three pages, incorporating them into the basics page. Do you agree with this choice? |
Think that makes sense to delete those pages. What doesn't make sense is having the same api-keys.md page twice (except for how to set). But that is out of the scope here. Will look at this shotly |
| ## Overview | ||
|
|
||
| Now that you have the SDK installed, the first step is to import the OpenBB SDK in your preferred code editor. Nearly everything required to interact with any function from the OpenBB Terminal gets imported in one line. Begin a Python script or Notebook file with: | ||
| The OpenBB SDK provides programmatic access to nearly all Terminal commands, allowing custom scripts and functions to power creations built on top of the core platform. It is easy to use and as flexible as one's imagination. The sections below will outline how to get started using it. If it isn't already installed, follow the instructions to install via [PyPi (pip)](https://docs.openbb.co/terminal/installation/pypi) or from the [source code](https://docs.openbb.co/terminal/installation/source). |
There was a problem hiding this comment.
So we should probably differentiate that the sdk itself (without all) can be installed pretty much anywhere? I can just fire up a venv, run pip install openbb and I am good to go.
There was a problem hiding this comment.
mmmm...that would mean we are telling people to install the Terminal this way, and we still want people to install by following the instructions so they don't make up their own methods and complain when "pip install doesn't work".
I think I have some install steps for Google CoLab that are now stable.
There was a problem hiding this comment.
Not sure if this is the ideal spot for these instructions... thoughts?
Ya, that was a discussion with @DidierRLopes during the Hub push, and we'll have to think of a better solution for this instead of maintaining two separate pages. |
reviewpad
bot
added
feat L
| The steps below assume that the developer container is Ubuntu-based. If using Google Colab, remove `sudo` from the commands. | ||
|
|
||
| **Step 1**: `sudo apt update && sudo apt upgrade` | ||
| **Step 2**: `sudo apt install libwebkit2gtk-4.0-dev` | ||
| **Step 3**: `pip install openbb`, or, `pip install openbb[optimization]` |
There was a problem hiding this comment.
colab can be done with a single line !pip install openbb
There was a problem hiding this comment.
If you want to launch it without the warning messages, then you need to install libwebkit.
|
One of the things that I am not seeing anywhere is the fact that all the base functionalities can be run using : |
Shouldn't these things be on the installation page? |
Yeah. I guess out of scope here. Will leave up to you |
This PR updates the SDK basics page to be current.