diff options
| author | andrewkenreich <andrew.kenreich@gmail.com> | 2022-11-28 12:13:47 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-28 12:13:47 -0500 |
| commit | 6381b2ae7def272da3df3b544ba91c6bf5362ad1 (patch) | |
| tree | d70c596510a263123e2efdb3f50f2fdcd20aa2dc | |
| parent | cca3b318565e3331b05b3cad5806298cfc4650e8 (diff) | |
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>
54 files changed, 6957 insertions, 6779 deletions
diff --git a/README.md b/README.md index 8433c9c75c4..d0492f8044e 100644 --- a/README.md +++ b/README.md @@ -98,14 +98,15 @@ If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of |**OpenBB Terminal**|**Usage**| |:-|:-| -|[Installer](https://docs.openbb.co/terminal/quickstart/installation)|Recommended way if you just want to use the OpenBB Terminal| -|[Docker](https://docs.openbb.co/terminal/quickstart/installation)|An alternative way if you just want to use the OpenBB Terminal| -|[Python](https://docs.openbb.co/terminal/quickstart/installation)|If you wish to contribute to the development of the OpenBB Terminal| +|[Windows Installer](https://docs.openbb.co/terminal/quickstart/installation?tab=windows)|Recommended way for Windows if you just want to use the OpenBB Terminal| +|[MacOS Installer](https://docs.openbb.co/terminal/quickstart/installation?tab=mac)|Recommended way for MacOS if you just want to use the OpenBB Terminal| +|[Docker](https://docs.openbb.co/terminal/quickstart/installation?tab=docker)|An alternative way if you just want to use the OpenBB Terminal| +|[Python](https://docs.openbb.co/terminal/quickstart/installation?tab=python)|If you wish to contribute to the development of the OpenBB Terminal| |**OpenBB SDK** |**Usage**| |:-|:-| |[PyPi](https://docs.openbb.co/sdk/quickstart/installation)|Recommended way if you just want to use the OpenBB SDK| -|[Python](https://docs.openbb.co/sdk/quickstart/installation)|If you wish to contribute to the development of the OpenBB SDK | +|[Python](https://docs.openbb.co/terminal/quickstart/installation?tab=python)|If you wish to contribute to the development of the OpenBB SDK | ## 3. Contributing diff --git a/openbb_terminal/terminal_helper.py b/openbb_terminal/terminal_helper.py index 67a729c3011..b4fd1284f51 100644 --- a/openbb_terminal/terminal_helper.py +++ b/openbb_terminal/terminal_helper.py @@ -126,16 +126,16 @@ def open_openbb_documentation( path = "/" command = "" elif "keys" in path: - path = "/guides/basics/keys" + path = "/guides/advanced/api-keys" command = "" elif "settings" in path: - path = "/guides/basics/customizing_the_terminal" + path = "/guides/advanced/customizing-the-terminal" command = "" elif "featflags" in path: - path = "/guides/basics/customizing_the_terminal" + path = "/guides/advanced/customizing-the-terminal" command = "" elif "sources" in path: - path = "/guides/advanced/changing_sources" + path = "/guides/advanced/changing-sources" command = "" else: if arg_type == "command": # user passed a command name @@ -158,22 +158,16 @@ def open_openbb_documentation( if command: if "keys" == command: - path = "/guides/basics/keys" + path = "/guides/advanced/api-keys" command = "" - elif "settings" in path: - path = "/guides/basics/customizing_the_terminal" - command = "" - elif "featflags" in path: - path = "/guides/basics/customizing_the_terminal" + elif "settings" in path or "featflags" in path: + path = "/guides/advanced/customizing-the-terminal" command = "" elif "sources" in path: - path = "/guides/advanced/changing_sources" + path = "/guides/advanced/changing-sources" command = "" elif "exe" == command: - path = "/quickstart/scripts" - command = "" - elif command in ["settings", "featflags", "sources"]: - path = "" + path = "/guides/advanced/scripts-and-routines" command = "" elif command in ["ta", "ba", "qa"]: path = f"/guides/intros/common/{command}" diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 00000000000..2380ec27b93 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,6 @@ +{ + "name": "OpenBB Terminal", + "lockfileVersion": 2, + "requires": true, + "packages": {} +} diff --git a/website/content/sdk/guides/basics/api-keys.md b/website/content/sdk/guides/advanced/api-keys.md index 0f8c35681ef..88c525a7f43 100644 --- a/website/content/sdk/guides/basics/api-keys.md +++ b/website/content/sdk/guides/advanced/api-keys.md @@ -1,6 +1,6 @@ --- title: Set API Keys -sidebar_position: 3 +sidebar_position: 1 --- API keys can be managed directly from the SDK environment. If there is already a Terminal installation configured with API keys, they will be recognized by the SDK. Their status can be verified with the line of code below. diff --git a/website/content/sdk/guides/advanced/changing-sources.md b/website/content/sdk/guides/advanced/changing-sources.md index 2386b8b2fa6..08137f8df0c 100644 --- a/website/content/sdk/guides/advanced/changing-sources.md +++ b/website/content/sdk/guides/advanced/changing-sources.md @@ -1,6 +1,6 @@ --- title: Changing Sources -sidebar_position: 1 +sidebar_position: 2 --- Some functions have the built-in capability of requesting data from multiple sources. `obb.stocks.load` is one example of this type feature: diff --git a/website/content/sdk/guides/advanced/chart_styling.md b/website/content/sdk/guides/advanced/chart-styling.md index b066ba94e2b..4d720240fb7 100644 --- a/website/content/sdk/guides/advanced/chart_styling.md +++ b/website/content/sdk/guides/advanced/chart-styling.md @@ -1,6 +1,6 @@ --- title: Adjusting Chart Style -sidebar_position: 2 +sidebar_position: 4 --- Within the OpenBB SDK, you can customize your chart style. You can switch between `dark` and `light` easily using this block of code: diff --git a/website/content/sdk/guides/basics/data.md b/website/content/sdk/guides/advanced/data.md index ecdcff8b63f..2931f8b096e 100644 --- a/website/content/sdk/guides/basics/data.md +++ b/website/content/sdk/guides/advanced/data.md @@ -1,6 +1,6 @@ --- title: Importing and Exporting Data -sidebar_position: 4 +sidebar_position: 3 --- The OpenBB SDK shares the `OpenBBUserData` folder with the Terminal, even with multiple versions installed on the same machine. Portfolio files, screener presets, and Matplotlib style sheets are all shared resources. This folder will be created after the first installation and it is read by subsequent installations. The default location for it is in the root of the operating system user account folder. @@ -13,4 +13,4 @@ Within the folder you can find files that you have exported as well as files tha <img width="1231" alt="Screen Shot 2022-10-13 at 6 45 01 PM" src="https://user-images.githubusercontent.com/85772166/195742985-19f0e420-d8f7-4fea-a145-a0243b8f2ddc.png"></img> -This folder contains all things user-created which are, among other things screener presets, portfolio files, files exported directly from the code, styles and themes, preferred data sources and API keys.
\ No newline at end of file +This folder contains all things user-created which are, among other things screener presets, portfolio files, files exported directly from the code, styles and themes, preferred data sources and API keys. diff --git a/website/content/sdk/guides/basics/_category_.json b/website/content/sdk/guides/basics/_category_.json index b5650dd9e65..c9c0b543e96 100644 --- a/website/content/sdk/guides/basics/_category_.json +++ b/website/content/sdk/guides/basics/_category_.json @@ -1,4 +1,4 @@ { "label": "Basics", - "position": 2 + "position": 1 }
\ No newline at end of file diff --git a/website/content/sdk/guides/basics/using.md b/website/content/sdk/guides/basics/index.md index 3dcdc41aa7b..45a961fe71b 100644 --- a/website/content/sdk/guides/basics/using.md +++ b/website/content/sdk/guides/basics/index.md @@ -1,15 +1,61 @@ --- -title: Using the SDK -sidebar_position: 2 +title: Basics +sidebar_position: 1 --- +### Importing the SDK -After you have imported the OpenBB SDK you are able to run many of the commands presents within the extensive list found [here]](/sdk/reference). +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: ```python from openbb_terminal.sdk import openbb ``` -For example, you are able to show Economic events by running the following command. Note that the results from data functions are not stored to memory unless explicitly instructed to. Most functions that return data are presented as a Pandas DataFrame. +Example snippets used in the remainder of this guide will assume the code block above is used. + +### Navigation + +In the same way as operating the OpenBB Terminal, functions are divided into menus which are scrollable after importing into a jupyter notebook. Entering a period, `.`, after `openbb`, will display the Sub-menus available. + + + +An alternate way to view the contents of a menu is to use Python's built-in help. + +```python +help(openbb.stocks.dd) +``` + +### Docstrings + +In addition to Python's built-in help, docstrings are also displayed in the Contextual Help window, within a Jupyter environment or by running `help(openbb.economy.events)` in your code editor. + +```python +help(openbb.economy.events) + +Help on Operation in module openbb_terminal.core.library.operation: + +<openbb_terminal.core.library.operation.Operation object> + Get economic calendar for countries between specified dates + + Parameters + ---------- + countries : [List[str],str] + List of countries to include in calendar. Empty returns all + start_date : str + Start date for calendar + end_date : str + End date for calendar + + Returns + ------- + pd.DataFrame + Economic calendar +``` + +## How to use the SDK + +### Your First Function + +To get started using the OpenBB SDK you can try the below code for your first function. ```python openbb.economy.events() @@ -23,7 +69,16 @@ openbb.economy.events() | 3 | 02:00 | United Kingdom | Claimant Count Change | 3.3K | 17.3K | 3.9K | 2022-11-15 | | 4 | 02:00 | United Kingdom | Employment Change 3M/3M | -52K | -25K | -109K | 2022-11-15 | -As most data is stored as a Pandas DataFrame, it is possible to adjust or filter the data directly through the use of the built-in functionalities of [Pandas](https://pandas.pydata.org/). For example, the code block below will filter the results of the events function to display only events scheduled at a specific time. +:::note - The results from data functions are not stored to memory unless explicitly instructed to. Most functions returning data are presented as a Pandas DataFrame. +::: + +Modify the syntax slightly to deliver the output into a DataFrame: + +```python +economic_calendar = openbb.economy.events() +``` + +Defined as a variable, interacting with the results becomes a matter of manipulating tables. For example, the code block below will filter the results of the events function to display only events scheduled at a specific time. ```python economic_calendar = openbb.economy.events() @@ -41,7 +96,13 @@ events ### Passing Results to Another Function -It may be desirable to derive a list of tickers from a different function. This can be useful for screening tickers, or analyzing particular industries or sectors. The Comparison Analysis sub-module, within Stocks, has one set of functions that can benefit from this kind of workflow. As an example, holdings with the highest allocation of the [Dow Jones Industrial Average ETF](https://www.ssga.com/us/en/intermediary/etfs/funds/spdr-dow-jones-industrial-average-etf-trust-dia) are used. +Let's take a look at another example where the input to a function is a list. It may be desirable to derive that list from a different function. This can be useful for screening tickers, or analyzing particular industries or sectors. The Comparison Analysis sub-module, within Stocks, is one set of functions that can benefit from this kind of workflow. Instead of something like: + +```python +openbb.stocks.ca.screener(similar = ['AAPL', 'NFLX', 'META', 'AMZN', 'MSFT', 'GOOGL', 'DIS', 'TSLA'], data_type = 'valuation') +``` + +Try, `openbb.etf.holdings`, to populate a list dynamically: ```python symbols = openbb.etf.holdings('DIA') @@ -60,9 +121,10 @@ dia_valuation.head(5) | 1 | AMGN | 1.5543e+11 | 22.86 | 15.4 | 3.38 | 5.9 | 41.77 | 13.54 | 32.04 | -0.165 | 0.0486 | 0.001 | 0.0677 | 0.025 | 283.6 | -0.006 | 2761083 | | 18 | MCD | 2.0272e+11 | 34.3 | 26.01 | 5.14 | 8.71 | N/A | 71.67 | 118.65 | 0.591 | 0.0522 | 0.13 | 0.0667 | -0.012 | 267.84 | -0.0163 | 5421817 | + ### Displaying Charts -The OpenBB SDK has built-in charting libraries for Matplotlib, for any chart available from the Terminal. User style sheets can be added to the folder (more on this in [Importing and Exporting Data](/sdk/guides/basics/data)), `~/OpenBBUserData/styles/user`. Styles are shared properties between the OpenBB Terminal and the SDK. +The OpenBB SDK has built-in charting libraries for Matplotlib, for any chart available from the Terminal. User style sheets can be added to the folder (more on this in [Importing and Exporting Data](/sdk/guides/advanced/data)), `~/OpenBBUserData/styles/user`. Styles are shared properties between the OpenBB Terminal and the SDK. :::note Displaying charts in Jupyter Notebooks requires an additional line of code. You can either render a static image with `%matplotlib inline` or add in pan/zoom functionality w |