mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-10 03:12:26 +00:00
a6042b8578
* bump * Update ALL the exports with sheet name option * Update contributing too * Add in sheet name to each docstring * Update tests * Fix the small things for tests * Converting CONTRIBUTING.md back since I put minimal changes in and it complains * Fix terminal exit after `--sort p/e` (#4013) * fix scr sort exit * rewrite unit test output * rewind slash replace * rewind slash replace * fix regex * rewrite expected scr tests * black Co-authored-by: James Maslek <jmaslek11@gmail.com> * fix: small typo (#4036) * fix income comparison error (#4029) * Update tests due to yfinance error * I broke tests and fixed them * Fix tests? * Missed a few sheet name additions * missed one more * Fix some missing sheet_name parameters * Fix a test I broke * Update tests due to changes with sheet_name * Update stocks and common * Mutual funds just because * Portfolio update * Update Forecast * Update Futures * Update ETF * Update Economy * Update Crypto * Update others * Update documentation to explain --sheet-name * It should be None test * Add None for sheet_name since empty string can result in errors * Formatting * Fix tests * Update documentation * Also update the image * Add back to options commands Co-authored-by: james <jmaslek11@gmail.com> Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: teh_coderer <me@tehcoderer.com>
75 lines
2.0 KiB
Python
75 lines
2.0 KiB
Python
"""AlphaQuery View"""
|
|
__docforma__ = "numpy"
|
|
|
|
import logging
|
|
import os
|
|
from datetime import datetime, timedelta
|
|
from typing import List, Optional
|
|
|
|
import matplotlib.pyplot as plt
|
|
|
|
from openbb_terminal.config_plot import PLOT_DPI
|
|
from openbb_terminal.config_terminal import theme
|
|
from openbb_terminal.decorators import log_start_end
|
|
from openbb_terminal.helper_funcs import (
|
|
export_data,
|
|
is_valid_axes_count,
|
|
plot_autoscale,
|
|
)
|
|
from openbb_terminal.rich_config import console
|
|
from openbb_terminal.stocks.options import alphaquery_model
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def display_put_call_ratio(
|
|
symbol: str,
|
|
window: int = 30,
|
|
start_date: str = (datetime.now() - timedelta(days=366)).strftime("%Y-%m-%d"),
|
|
export: str = "",
|
|
sheet_name: str = None,
|
|
external_axes: Optional[List[plt.Axes]] = None,
|
|
):
|
|
"""Display put call ratio [Source: AlphaQuery.com]
|
|
|
|
Parameters
|
|
----------
|
|
symbol : str
|
|
Stock ticker symbol
|
|
window : int, optional
|
|
Window length to look at, by default 30
|
|
start_date : str, optional
|
|
Starting date for data, by default (datetime.now() - timedelta(days=366)).strftime("%Y-%m-%d")
|
|
export : str, optional
|
|
Format to export data, by default ""
|
|
external_axes : Optional[List[plt.Axes]], optional
|
|
External axes (1 axis is expected in the list), by default None
|
|
"""
|
|
pcr = alphaquery_model.get_put_call_ratio(symbol, window, start_date)
|
|
if pcr.empty:
|
|
console.print("No data found.\n")
|
|
return
|
|
|
|
if not external_axes:
|
|
_, ax = plt.subplots(figsize=plot_autoscale(), dpi=PLOT_DPI)
|
|
elif is_valid_axes_count(external_axes, 1):
|
|
(ax,) = external_axes
|
|
else:
|
|
return
|
|
|
|
ax.plot(pcr.index, pcr.values)
|
|
ax.set_title(f"Put Call Ratio for {symbol.upper()}")
|
|
theme.style_primary_axis(ax)
|
|
|
|
if not external_axes:
|
|
theme.visualize_output()
|
|
|
|
export_data(
|
|
export,
|
|
os.path.dirname(os.path.abspath(__file__)),
|
|
"pcr",
|
|
pcr,
|
|
sheet_name,
|
|
)
|