mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-15 22:02:31 +00:00
* broken edition * Fixed issue * Update StockController * Update choices generation * Update parent_classes * Update choices generation * Update choices generation * Update crypto_controller * Update DefiController * Update crypto/disc controller * Update crypto/dd * Update choices generation * Update crypto : dd + nft * Update crypto/onchain * Update crypto_controller * Linting * Update crypto/ov * Linting * Update crypto/ov * Update crypto/qa * Update crypto/tools * Update crypto/ta + dd * Linting * Update alt * Tests fix crypto * Update future * Update futures * Refactored through Options * Tests + Linting * finished stocks refactor * Update stocks/sia * finished stocks refactor * Added fixes * Added fix * Tests * Fix conditions * Fix portfolio * Prepare for merge Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: northern-64bit <75195383+northern-64bit@users.noreply.github.com>
366 lines
11 KiB
Python
366 lines
11 KiB
Python
""" Due Diligence Controller """
|
|
__docformat__ = "numpy"
|
|
|
|
import argparse
|
|
import logging
|
|
from typing import List
|
|
|
|
from pandas.core.frame import DataFrame
|
|
|
|
from openbb_terminal.custom_prompt_toolkit import NestedCompleter
|
|
|
|
from openbb_terminal import feature_flags as obbff
|
|
from openbb_terminal.decorators import log_start_end
|
|
from openbb_terminal.helper_funcs import (
|
|
EXPORT_BOTH_RAW_DATA_AND_FIGURES,
|
|
EXPORT_ONLY_RAW_DATA_ALLOWED,
|
|
check_positive,
|
|
)
|
|
from openbb_terminal.menu import session
|
|
from openbb_terminal.parent_classes import StockBaseController
|
|
from openbb_terminal.rich_config import console, MenuText
|
|
from openbb_terminal.stocks.due_diligence import (
|
|
ark_view,
|
|
business_insider_view,
|
|
csimarket_view,
|
|
finnhub_view,
|
|
finviz_view,
|
|
fmp_view,
|
|
marketwatch_view,
|
|
)
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class DueDiligenceController(StockBaseController):
|
|
"""Due Diligence Controller class"""
|
|
|
|
CHOICES_COMMANDS = [
|
|
"load",
|
|
"sec",
|
|
"rating",
|
|
"pt",
|
|
"rot",
|
|
"est",
|
|
"analyst",
|
|
"supplier",
|
|
"customer",
|
|
"arktrades",
|
|
]
|
|
PATH = "/stocks/dd/"
|
|
ESTIMATE_CHOICES = ["annualrevenue", "annualearnings", "quarterearnings"]
|
|
CHOICES_GENERATION = True
|
|
|
|
def __init__(
|
|
self,
|
|
ticker: str,
|
|
start: str,
|
|
interval: str,
|
|
stock: DataFrame,
|
|
queue: List[str] = None,
|
|
):
|
|
"""Constructor"""
|
|
super().__init__(queue)
|
|
|
|
self.ticker = ticker
|
|
self.start = start
|
|
self.interval = interval
|
|
self.stock = stock
|
|
|
|
if session and obbff.USE_PROMPT_TOOLKIT:
|
|
choices: dict = self.choices_default
|
|
|
|
self.completer = NestedCompleter.from_nested_dict(choices)
|
|
|
|
def print_help(self):
|
|
"""Print help"""
|
|
mt = MenuText("stocks/dd/", 90)
|
|
mt.add_cmd("load")
|
|
mt.add_raw("\n")
|
|
mt.add_param("_ticker", self.ticker.upper())
|
|
mt.add_raw("\n")
|
|
mt.add_cmd("analyst")
|
|
mt.add_cmd("rating")
|
|
mt.add_cmd("rot")
|
|
mt.add_cmd("pt")
|
|
mt.add_cmd("est")
|
|
mt.add_cmd("sec")
|
|
mt.add_cmd("supplier")
|
|
mt.add_cmd("customer")
|
|
mt.add_cmd("arktrades")
|
|
console.print(text=mt.menu_text, menu="Stocks - Due Diligence")
|
|
|
|
def custom_reset(self) -> List[str]:
|
|
"""Class specific component of reset command"""
|
|
if self.ticker:
|
|
return ["stocks", f"load {self.ticker}", "dd"]
|
|
return []
|
|
|
|
@log_start_end(log=logger)
|
|
def call_analyst(self, other_args: List[str]):
|
|
"""Process analyst command"""
|
|
parser = argparse.ArgumentParser(
|
|
add_help=False,
|
|
prog="analyst",
|
|
description="""
|
|
Print analyst prices and ratings of the company. The following fields are expected:
|
|
date, analyst, category, price from, price to, and rating. [Source: Finviz]
|
|
""",
|
|
)
|
|
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_ONLY_RAW_DATA_ALLOWED
|
|
)
|
|
if ns_parser:
|
|
finviz_view.analyst(symbol=self.ticker, export=ns_parser.export)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_pt(self, other_args: List[str]):
|
|
"""Process pt command"""
|
|
parser = argparse.ArgumentParser(
|
|
add_help=False,
|
|
prog="pt",
|
|
description="""Prints price target from analysts. [Source: Business Insider]""",
|
|
)
|
|
parser.add_argument(
|
|
"--raw",
|
|
action="store_true",
|
|
dest="raw",
|
|
help="Only output raw data",
|
|
)
|
|
parser.add_argument(
|
|
"-l",
|
|
"--limit",
|
|
action="store",
|
|
dest="limit",
|
|
type=check_positive,
|
|
default=10,
|
|
help="Limit of latest price targets from analysts to print.",
|
|
)
|
|
|
|
if other_args and "-" not in other_args[0][0]:
|
|
other_args.insert(0, "-l")
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_BOTH_RAW_DATA_AND_FIGURES
|
|
)
|
|
if ns_parser:
|
|
business_insider_view.price_target_from_analysts(
|
|
symbol=self.ticker,
|
|
data=self.stock,
|
|
start_date=self.start,
|
|
limit=ns_parser.limit,
|
|
raw=ns_parser.raw,
|
|
export=ns_parser.export,
|
|
)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_est(self, other_args: List[str]):
|
|
"""Process est command"""
|
|
parser = argparse.ArgumentParser(
|
|
add_help=False,
|
|
prog="est",
|
|
description="""Yearly estimates and quarter earnings/revenues.
|
|
[Source: Business Insider]""",
|
|
)
|
|
parser.add_argument(
|
|
"-e",
|
|
"--estimate",
|
|
help="Estimates to get",
|
|
dest="estimate",
|
|
choices=self.ESTIMATE_CHOICES,
|
|
default="annualearnings",
|
|
)
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_ONLY_RAW_DATA_ALLOWED
|
|
)
|
|
if ns_parser:
|
|
business_insider_view.estimates(
|
|
symbol=self.ticker,
|
|
estimate=ns_parser.estimate,
|
|
export=ns_parser.export,
|
|
)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_rot(self, other_args: List[str]):
|
|
"""Process rot command"""
|
|
parser = argparse.ArgumentParser(
|
|
add_help=False,
|
|
prog="rot",
|
|
description="""
|
|
Rating over time (monthly). [Source: Finnhub]
|
|
""",
|
|
)
|
|
parser.add_argument(
|
|
"-l",
|
|
"--limit",
|
|
action="store",
|
|
dest="limit",
|
|
type=check_positive,
|
|
default=10,
|
|
help="Limit of last months",
|
|
)
|
|
parser.add_argument(
|
|
"--raw",
|
|
action="store_true",
|
|
dest="raw",
|
|
help="Only output raw data",
|
|
)
|
|
|
|
if other_args and "-" not in other_args[0][0]:
|
|
other_args.insert(0, "-l")
|
|
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_BOTH_RAW_DATA_AND_FIGURES
|
|
)
|
|
if ns_parser:
|
|
finnhub_view.rating_over_time(
|
|
symbol=self.ticker,
|
|
limit=ns_parser.limit,
|
|
raw=ns_parser.raw,
|
|
export=ns_parser.export,
|
|
)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_rating(self, other_args: List[str]):
|
|
"""Process rating command"""
|
|
parser = argparse.ArgumentParser(
|
|
add_help=False,
|
|
prog="rating",
|
|
description="""
|
|
Based on specific ratios, prints information whether the company
|
|
is a (strong) buy, neutral or a (strong) sell. The following fields are expected:
|
|
P/B, ROA, DCF, P/E, ROE, and D/E. [Source: Financial Modeling Prep]
|
|
""",
|
|
)
|
|
parser.add_argument(
|
|
"-l",
|
|
"--limit",
|
|
action="store",
|
|
dest="limit",
|
|
type=check_positive,
|
|
default=10,
|
|
help="limit of last days to display ratings",
|
|
)
|
|
|
|
if other_args and "-" not in other_args[0][0]:
|
|
other_args.insert(0, "-l")
|
|
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_ONLY_RAW_DATA_ALLOWED
|
|
)
|
|
if ns_parser:
|
|
fmp_view.rating(
|
|
symbol=self.ticker,
|
|
limit=ns_parser.limit,
|
|
export=ns_parser.export,
|
|
)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_sec(self, other_args: List[str]):
|
|
"""Process sec command"""
|
|
parser = argparse.ArgumentParser(
|
|
add_help=False,
|
|
prog="sec",
|
|
description="""
|
|
Prints SEC filings of the company. The following fields are expected: Filing Date,
|
|
Document Date, Type, Category, Amended, and Link. [Source: Market Watch]
|
|
""",
|
|
)
|
|
parser.add_argument(
|
|
"-l",
|
|
"--limit",
|
|
action="store",
|
|
dest="limit",
|
|
type=check_positive,
|
|
default=5,
|
|
help="number of latest SEC filings.",
|
|
)
|
|
|
|
if other_args and "-" not in other_args[0][0]:
|
|
other_args.insert(0, "-l")
|
|
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_ONLY_RAW_DATA_ALLOWED
|
|
)
|
|
if ns_parser:
|
|
marketwatch_view.sec_filings(
|
|
symbol=self.ticker,
|
|
limit=ns_parser.limit,
|
|
export=ns_parser.export,
|
|
)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_supplier(self, other_args: List[str]):
|
|
"""Process supplier command"""
|
|
parser = argparse.ArgumentParser(
|
|
prog="supplier",
|
|
add_help=False,
|
|
description="List of suppliers from ticker provided. [Source: CSIMarket]",
|
|
)
|
|
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_ONLY_RAW_DATA_ALLOWED
|
|
)
|
|
if ns_parser:
|
|
csimarket_view.suppliers(
|
|
symbol=self.ticker,
|
|
export=ns_parser.export,
|
|
)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_customer(self, other_args: List[str]):
|
|
"""Process customer command"""
|
|
parser = argparse.ArgumentParser(
|
|
prog="customer",
|
|
add_help=False,
|
|
description="List of customers from ticker provided. [Source: CSIMarket]",
|
|
)
|
|
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, EXPORT_ONLY_RAW_DATA_ALLOWED
|
|
)
|
|
if ns_parser:
|
|
csimarket_view.customers(
|
|
symbol=self.ticker,
|
|
export=ns_parser.export,
|
|
)
|
|
|
|
@log_start_end(log=logger)
|
|
def call_arktrades(self, other_args):
|
|
"""Process arktrades command"""
|
|
parser = argparse.ArgumentParser(
|
|
add_help=False,
|
|
prog="arktrades",
|
|
description="""
|
|
Get trades for ticker across all ARK funds.
|
|
""",
|
|
)
|
|
parser.add_argument(
|
|
"-l",
|
|
"--limit",
|
|
help="Limit of rows to show",
|
|
dest="limit",
|
|
default=10,
|
|
type=check_positive,
|
|
)
|
|
parser.add_argument(
|
|
"-s",
|
|
"--show_symbol",
|
|
action="store_true",
|
|
default=False,
|
|
help="Flag to show ticker in table",
|
|
dest="show_symbol",
|
|
)
|
|
if other_args and "-" not in other_args[0][0]:
|
|
other_args.insert(0, "-l")
|
|
ns_parser = self.parse_known_args_and_warn(
|
|
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
|
|
)
|
|
if ns_parser:
|
|
ark_view.display_ark_trades(
|
|
symbol=self.ticker,
|
|
limit=ns_parser.limit,
|
|
show_symbol=ns_parser.show_symbol,
|
|
export=ns_parser.export,
|
|
)
|