mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 22:11:55 +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>
113 lines
2.6 KiB
Python
113 lines
2.6 KiB
Python
"""Tools View"""
|
|
__docformat__ = "numpy"
|
|
|
|
import logging
|
|
import os
|
|
|
|
from openbb_terminal.cryptocurrency.tools.tools_model import calculate_apy, calculate_il
|
|
from openbb_terminal.helper_funcs import export_data, print_rich_table
|
|
from openbb_terminal.rich_config import console
|
|
from openbb_terminal.decorators import log_start_end
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def display_apy(
|
|
apr: float,
|
|
compounding_times: int,
|
|
narrative: bool = False,
|
|
export: str = "",
|
|
sheet_name: str = None,
|
|
):
|
|
"""Displays APY value converted from APR
|
|
|
|
Parameters
|
|
----------
|
|
apr: float
|
|
value in percentage
|
|
compounding_times: int
|
|
number of compounded periods in a year
|
|
narrative: str
|
|
display narrative version instead of dataframe
|
|
export : str
|
|
Export dataframe data to csv,json,xlsx file
|
|
|
|
Returns
|
|
-------
|
|
"""
|
|
df, apy_str = calculate_apy(apr, compounding_times)
|
|
|
|
if narrative:
|
|
console.print(apy_str)
|
|
else:
|
|
print_rich_table(
|
|
df,
|
|
headers=list(df.columns),
|
|
show_index=False,
|
|
title="APR/APY Calculator",
|
|
)
|
|
|
|
export_data(
|
|
export,
|
|
os.path.dirname(os.path.abspath(__file__)),
|
|
"aprtoapy",
|
|
apy_str,
|
|
sheet_name,
|
|
)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def display_il(
|
|
price_changeA: int,
|
|
price_changeB: int,
|
|
proportion: int,
|
|
initial_pool_value: int,
|
|
narrative: bool = False,
|
|
export: str = "",
|
|
sheet_name: str = None,
|
|
):
|
|
"""Displays Impermanent Loss in a custom liquidity pool
|
|
|
|
Parameters
|
|
----------
|
|
price_changeA: float
|
|
price change of crypto A in percentage
|
|
price_changeB: float
|
|
price change of crypto B in percentage
|
|
proportion: float
|
|
percentage of first token in pool
|
|
initial_pool_value: float
|
|
initial value that pool contains
|
|
narrative: str
|
|
display narrative version instead of dataframe
|
|
export : str
|
|
Export dataframe data to csv,json,xlsx file
|
|
|
|
Returns
|
|
-------
|
|
"""
|
|
df, il_str = calculate_il(
|
|
price_changeA=price_changeA,
|
|
price_changeB=price_changeB,
|
|
proportion=proportion,
|
|
initial_pool_value=initial_pool_value,
|
|
)
|
|
if narrative:
|
|
console.print(il_str)
|
|
else:
|
|
print_rich_table(
|
|
df,
|
|
headers=list(df.columns),
|
|
show_index=False,
|
|
title="Impermanent Loss Calculator",
|
|
)
|
|
|
|
export_data(
|
|
export,
|
|
os.path.dirname(os.path.abspath(__file__)),
|
|
"il",
|
|
df,
|
|
sheet_name,
|
|
)
|