Merge branch 'develop' into release/4.0.1

.github/workflows/labels-PR.yml

@@ -10,7 +10,7 @@ jobs:
         with:
           mode: minimum
           count: 1
-          labels: "guides, bug, build, do not merge, docker, docs, duplicate, enhancement, feat XS, feat S, feat M, feat L, feat XL, help wanted, refactor, tests, discord, dependencies, notebookreports, dashboards, analytics, portfolio, installer, platform, release "
+          labels: "guides, bug, build, docker, docs, feat XS, feat S, feat M, feat L, feat XL, help wanted, refactor, tests, dependencies, release"
       - uses: mheap/github-action-required-labels@v1
         with:
           mode: exactly

README.md

@@ -11,6 +11,9 @@
 <a href="https://codespaces.new/OpenBB-finance/OpenBBTerminal">
   <img src="https://github.com/codespaces/badge.svg" height="20" />
 </a>
+<a target="_blank" href="https://colab.research.google.com/github/OpenBB-finance/OpenBBTerminal/blob/develop/examples/googleColab.ipynb">
+  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
 
 The first financial terminal that is free and fully open source. With over 600 commands, the terminal has access to equity, options, crypto, forex, macro economy, fixed income, alternative datasets, and more.
 

examples/README.md

@@ -1,76 +1,49 @@
-# Jupyter Notebook Examples Using the OpenBB SDK
+# Jupyter Notebook Examples Using the OpenBB Platform
 
-This folder is a collection of example notebooks that demonstrate some of the ways to get started using the OpenBB SDK.  To run them, ensure that the active kernel selected is the same Python virtual environment where OpenBB was installed.
+This folder is a collection of example notebooks that demonstrate some of the ways to get started with using the OpenBB Platform.  To run them, ensure that the active kernel selected is the same Python virtual environment where OpenBB was installed.
 
 ## Table of Contents
 
-### loadHistoricalPriceData
-
-This notebook walks through collecting historical price data using a variety of methods and sources.
-
-- Loading data with different intervals, and changing sources.
-- A brief explanation of ticker symbology.
-- Using other functions and modules to load data with besides `openbb.stocks.load()`.
-- Gang-loading a list of tickers' price data in a single call.
-- Drawing candle and line charts.
-
-### copperToGoldRatio
-
-This notebook explains how to calculate and plot the Copper-to-Gold ratio.
-
-- Loading historical front-month futures prices.
-- Getting the historical series from FRED for the 10-year constant maturity US treasury bill.
-- Performing basic DataFrame operations.
-- Creating OpenBB Figure objects, and plotting on two y-axis.
-
-### realizedVolatilityModels
+### googleColab
 
-This notebook demonstrates the six, realized volatility models with in the Technical Analysis module.
+This notebook installs the OpenBB Platform in a Google Colab environment with examples for:
 
-- Explore differences between:
-  - Standard Deviation
-  - Parkinson
-  - Hodges-Tompkins
-  - Garman-Klass
-  - Rogers-Satchell
-  - Yang-Zhang
-- Creating and plotting realized volatility cones.
-- Overlaying multiple time series.
-- Use the calculated outputs as inputs to a forecast model.
+- Logging into OpenBB Hub
+- Setting the output preference
+- Fetching options and company fundamentals data
+- Creating bar chart visualizations
 
-### usdLiquidityIndex
+### findSymbols
 
-This notebook demonstrates how to query the Federal Reserve Economic Database and recreate the USD Liquidity Index.
+This notebook provides an introduction to discovering, finding, and searching ticker symbols.
 
-- Search FRED for series IDs.
-- Load multiple series as a single call.
-- Unpacking the data response from the FRED query.
-- Perform arithmetic operations on a DataFrame.
-- Normalization methods for a series or DataFrame.
-- Simple processes for creating charts.
+- Search
+- Find company and institutional filings
+- Screen stocks by region and metrics
 
-### optionsChains
+### loadHistoricalPriceData
 
-This notebook demonstrates how to fetch and work with options chains data.
+This notebook walks through collecting historical price data, at different intervals, using a variety of sources.
 
-- Use the new method for loading options chains data.
-- Examine the differences of the data, between sources.
-- Calculate and visualize volume and open interest by strike and expiration.
-- Calculate and visualize the Net Delta Exposure, in dollars, by strike and expiration.
-- Visualize the term structure of the implied volatility skew.
-- Get tables with multiple single-leg options strategies.
+- Loading data with different intervals, and changing sources
+- A brief explanation of ticker symbology
+- Resampling a time series index
+- Some differences between providers, and comparing outputs
 
-### googleColabInstallation
+### financialStatements
 
-This notebook demonstrates how to install the OpenBB SDK within Google Colab.
+This set of examples introduces financial statements in the OpenBB Platform and compares the free cash flow yields of large-cap retail industry companies.
 
+- Financial statements
+- What to expect with data from different sources
+- Financial attributes
+- Ratios and other metrics
 
-### volumeAtPrice
+### copperToGoldRatio
 
-Volume-at-price is a chart used by technical analysts as a visual gauge to where the trading levels are concentrated, relative to price and volume.  In short, it is the sum of volume at different price levels.  This notebook utilizes individual components of the OpenBB SDK and combines them to build a new view.
+This notebook explains how to calculate and plot the Copper-to-Gold ratio.
 
-- Price
-- Volume
-- VWAP
-- SMA
-- OpenBBFigure
+- Loading historical front-month futures prices.
+- Getting the historical series from FRED for the 10-year constant maturity US treasury bill.
+- Performing basic DataFrame operations.
+- Creating charts with Plotly Graph Objects.