Files
OpenBB/openbb_terminal/keys_controller.py
montezdesousa 5953be0a42 Terminal authentication + keys/settings/routines (#4015)
* import order

* pylint

* no login, go to prompt

* add logout and whoami

* clear before prompt

* black

* these are unecessary

* error

* improve login prompt message

* login does not follow the controller pattern, so will name it differently

* nop

* move logout and change to results

* change return obj

* ruff

* pyupgrade

* remove user from statics

* message

* fetch configs at start

* remove unecessary func

* unecessary dataclass

* change user vars

* change login flow

* remote logout should not be used

* simplify

* fix double exit logout bug

* wrong exception

* apply keys

* change controller

* mypy

* save if no internet

* pylint

* logout everywhere

* breaking changes: move to local/hub models

* unused import

* fix logout bug

* whoami in guest mode

* add todo

* small bug guest allowed

* limit flair length

* fix bug on user pull

* logout working

* handle no connection

* logout user when logout

* remove keys push

* split logger funcs

* commant apply configs for now

* account to session

* rename user

* clear sounds better

* breaking changes: splitting guest from logged users

* pull imports up

* delete session model

* move logout func

* add ability to save and apply keys from remote

* no sensitive keys

* add support for feature flags

* unecessary print

* allow settings from differnt modules

* change setff to static

* change way to set ff

* fix bug in applying configs

* simplify obbff application

* bug on setting configs

* allow text ff

* obbff in settings

* add upload to cfg_plot 1

* data sources + backend

* this solves circular import?

* move create_session to model

* rever logs changes, not needed for now

* sync optionally

* outline account controller interface

* don't sync when guest

* block guest on installer

* or not and

* start routines

* fix bug on ff, settings

* is installer

* implementing chavi suggestions

* fix colors on installer prompt

* Logging login (#4046)

* basic logging for the login

* removing unused import

* hacking the logs custom filter to not filter the email

* black

* cooping with the new changes

* removing redundant method

* ruff

* ruff

* mypy

* SDK login (#4051)

* sdk login

* adding to the trail map

* minor fix

* improve sdk expirience

* adapting to new changes

* add docstrings

* block guest from account

* change guest msg

* change guest messages

* add sync on/off

* display onoff

* missing paragraph

* fix glitch on logout

* add sys clear

* filtering password

* filtering the email from user

* avoid writing to multiple log files if a user logs out

* fix bug, guest allowed in installer without connection

* log user on the sdk

* split login from lauch

* add clear and change messages on account

* docstrings

* start pull cmd

* change account menu description

* Fix login bug and decouple some logic (#4056)

* fix bug, guest allowed in installer without connection

* split login from lauch

* improvements on the sdk login

---------

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>

* sync fix

* change account controller description

* ruff

* add help on account cmds

* update clear prompt

* fix email not in jwt

* remove jwt from requiremnts

* pull command output

* remove character

* pull cmd when no data

* add space below whoami

* fix log filenotfound exception

* changed arg name

* delete .hist on logout

* add asteriscs to password

* pylint

* uncomment rich config

* show only diffs on pull

* black#

* warn when no changes#

* pull msg was switched

* apply diff only

* breaking?: strbool change

* reduce some code

* add timeout to hub requests

* black

* add remote logout

* success msg only if success

* remove colors in prompt

* update docstrings

* keep timeout outside funcs

* update clear

* clear and patch

* delete session

* routine upload

* move .his file to .openbb folder

* change apply configs

* refactor logout

* remove mixed portfolio changes

* fix bug in lock file

* fix bug pwidth, pheight are floats

* fix sources command & add choices

* refactor timezone setting

* userdata

* fix flair

* need to cast paths

* cast on diff

* fix flair default

* save session test

* get session

* data

* test remove

* test remove with assert

* add bad test cases

* add exception cases to unittests

* test remove cli hist file

* black

* test apply configs

* test apply with sync flag

* test create session, session model

* login tests, session model

* some tests for the hub_model

* test logout user

* black

* test clear vars, reload

* test create session

* update user-json to user

* update user class

* add user tests

* tests sdk session

* tests for hub_model

* start account controller tsts

* unused import

* tests account controller: clear, pull

* tests for session_controller

* logout success bugfix

* add integration test for account

* black

* move routine related commands to other PR

* test for the user input

* completed tests for session controller

* convert to hist to str)

* fix import errors

* ruff

* ruff tests

* fix qa

* add help to settings cmds

* ruff

* fix pull keys bug

* point to dev

* account model tests

* black

* ruff

* fix for empty feature settings

* ruff

* don't display config msg if wrong token

* general msgs

* remove print

* ruff

* fix sources not updated real time

* missing return doc

* add guest if no email

* Routine remote storage (#4143)

* add upload routine command

* remove prints

* point to local again

* add commands

* add delete

* add download command and upload 409

* list comprehension

* add download & save plus upload fixe

* add user uuid folder

* add list command

* ruff

* en.yml detail

* provide choices to delete & download

* add choices to upload

* change menu text

* starting adding unit tests

* bad english

* Update test_print_help.txt

* genearl msgs

* remove print

* add docstrings

* add unit tests to account controller

* change parser

* fix routine upload test

* add to be implemented tests hub

* add to be implemented tests local

* add total pages to title

* split list into model and view

* add docstring

* print msg if character

* add local model tests

* hub tests routines

* fix test

* point to dev and glob

* fix small bug on upload

* missing return

* log decorators missing

* black

* ruff

* change prompt display

* rewrite test

* rewrite expected

* rewrite call

* try passing git action

* change .yml everywhere

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-02-09 13:35:44 +00:00

1161 lines
38 KiB
Python

"""Keys Controller Module"""
__docformat__ = "numpy"
# pylint: disable=too-many-lines
import argparse
import logging
from typing import Dict, List
from tqdm import tqdm
from openbb_terminal import (
feature_flags as obbff,
keys_model,
keys_view,
)
from openbb_terminal.custom_prompt_toolkit import NestedCompleter
from openbb_terminal.decorators import log_start_end
from openbb_terminal.helper_funcs import EXPORT_ONLY_RAW_DATA_ALLOWED
from openbb_terminal.menu import session
from openbb_terminal.parent_classes import BaseController
from openbb_terminal.rich_config import MenuText, console, translate
logger = logging.getLogger(__name__)
class KeysController(BaseController): # pylint: disable=too-many-public-methods
"""Keys Controller class"""
API_DICT = keys_model.API_DICT
API_LIST = list(API_DICT.keys())
CHOICES_COMMANDS: List[str] = ["mykeys"] + API_LIST
PATH = "/keys/"
status_dict: Dict = {}
def __init__(
self,
queue: List[str] = None,
menu_usage: bool = True,
):
"""Constructor"""
super().__init__(queue)
if menu_usage:
if session and obbff.USE_PROMPT_TOOLKIT:
choices: dict = {c: {} for c in self.controller_choices}
choices["support"] = self.SUPPORT_CHOICES
self.completer = NestedCompleter.from_nested_dict(choices)
def check_keys_status(self) -> None:
"""Check keys status"""
for api in tqdm(self.API_LIST, desc="Checking keys status"):
self.status_dict[api] = getattr(keys_model, "check_" + str(api) + "_key")()
def print_help(self):
"""Print help"""
self.check_keys_status()
mt = MenuText("keys/")
mt.add_info("_keys_")
mt.add_raw("\n")
mt.add_cmd("mykeys")
mt.add_raw("\n")
mt.add_info("_status_")
for cmd_name, status_msg in self.status_dict.items():
api_name = self.API_DICT[cmd_name]
c = "grey30"
if status_msg == str(keys_model.KeyStatus.DEFINED_TEST_PASSED):
c = "green"
elif status_msg == str(keys_model.KeyStatus.DEFINED_TEST_FAILED):
c = "red"
elif status_msg == str(keys_model.KeyStatus.DEFINED_NOT_TESTED):
c = "yellow"
elif status_msg == str(keys_model.KeyStatus.DEFINED_TEST_INCONCLUSIVE):
c = "yellow"
elif status_msg == str(keys_model.KeyStatus.NOT_DEFINED):
c = "grey30"
if status_msg is None:
status_msg = str(keys_model.KeyStatus.NOT_DEFINED)
mt.add_raw(
f" [cmds]{cmd_name}[/cmds] {(20 - len(cmd_name)) * ' '}"
f" [{c}] {api_name} {(25 - len(api_name)) * ' '} {translate(status_msg)} [/{c}]\n"
)
console.print(text=mt.menu_text, menu="Keys")
@log_start_end(log=logger)
def call_mykeys(self, other_args: List[str]):
"""Display current keys"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="mykeys",
description="Display current keys.",
)
parser.add_argument(
"-s", "--show", type=bool, dest="show", help="show", default=False
)
if other_args and "-s" in other_args[0]:
other_args.insert(1, "True")
ns_parser = self.parse_known_args_and_warn(
parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED
)
if ns_parser:
keys_view.display_keys(
show=ns_parser.show,
export=ns_parser.export,
sheet_name=" ".join(ns_parser.sheet_name)
if ns_parser.sheet_name
else None,
)
@log_start_end(log=logger)
def call_av(self, other_args: List[str]):
"""Process av command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="av",
description="Set Alpha Vantage API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://www.alphavantage.co/support/#api-key\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["av"] = keys_model.set_av_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_fmp(self, other_args: List[str]):
"""Process fmp command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="fmp",
description="Set Financial Modeling Prep API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://financialmodelingprep.com\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["fmp"] = keys_model.set_fmp_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_quandl(self, other_args: List[str]):
"""Process quandl command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="quandl",
description="Set Quandl API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://www.quandl.com\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["quandl"] = keys_model.set_quandl_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_polygon(self, other_args: List[str]):
"""Process polygon command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="polygon",
description="Set Polygon API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://polygon.io\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["polygon"] = keys_model.set_polygon_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_fred(self, other_args: List[str]):
"""Process FRED command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="fred",
description="Set FRED API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://fred.stlouisfed.org\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["fred"] = keys_model.set_fred_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_news(self, other_args: List[str]):
"""Process News API command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="news",
description="Set News API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://newsapi.org\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["news"] = keys_model.set_news_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_tradier(self, other_args: List[str]):
"""Process Tradier API command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="tradier",
description="Set Tradier API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://developer.tradier.com\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["tradier"] = keys_model.set_tradier_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_cmc(self, other_args: List[str]):
"""Process CoinMarketCap API command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="cmc",
description="Set CMC API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://coinmarketcap.com\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["cmc"] = keys_model.set_cmc_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_finnhub(self, other_args: List[str]):
"""Process Finnhub API command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="finnhub",
description="Set Finnhub API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://finnhub.io\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["finnhub"] = keys_model.set_finnhub_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_iex(self, other_args: List[str]):
"""Process iex command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="iex",
description="Set IEX Cloud API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://iexcloud.io\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["iex"] = keys_model.set_iex_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_reddit(self, other_args: List[str]):
"""Process reddit command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="reddit",
description="Set Reddit API key.",
)
parser.add_argument(
"-i",
"--id",
type=str,
dest="client_id",
help="Client ID",
required="-h" not in other_args,
)
parser.add_argument(
"-s",
"--secret",
type=str,
dest="client_secret",
help="Client Secret",
required="-h" not in other_args,
)
parser.add_argument(
"-u",
"--username",
type=str,
dest="username",
help="Username",
required="-h" not in other_args,
)
parser.add_argument(
"-p",
"--password",
type=str,
dest="password",
help="Password",
required="-h" not in other_args,
)
parser.add_argument(
"-a",
"--agent",
type=str,
dest="user_agent",
help="User agent",
required="-h" not in other_args,
nargs="+",
)
if not other_args:
console.print("For your API Key, visit: https://www.reddit.com\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
slash_components = "".join([f"/{val}" for val in self.queue])
useragent = " ".join(ns_parser.user_agent) + " " + slash_components
useragent = useragent.replace('"', "")
self.queue = []
self.status_dict["reddit"] = keys_model.set_reddit_key(
client_id=ns_parser.client_id,
client_secret=ns_parser.client_secret,
password=ns_parser.password,
username=ns_parser.username,
useragent=useragent,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_twitter(self, other_args: List[str]):
"""Process twitter command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="twitter",
description="Set Twitter API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="Key",
required="-h" not in other_args,
)
parser.add_argument(
"-s",
"--secret",
type=str,
dest="secret",
help="Secret key",
required="-h" not in other_args,
)
parser.add_argument(
"-t",
"--token",
type=str,
dest="token",
help="Bearer token",
required="-h" not in other_args,
)
if not other_args:
console.print("For your API Key, visit: https://developer.twitter.com\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["twitter"] = keys_model.set_twitter_key(
key=ns_parser.key,
secret=ns_parser.secret,
access_token=ns_parser.token,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_rh(self, other_args: List[str]):
"""Process rh command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="rh",
description="Set Robinhood API key.",
)
parser.add_argument(
"-u",
"--username",
type=str,
dest="username",
help="username",
)
parser.add_argument(
"-p",
"--password",
type=str,
dest="password",
help="password",
)
if not other_args:
console.print("For your API Key, visit: https://robinhood.com/us/en/\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["rh"] = keys_model.set_rh_key(
username=ns_parser.username,
password=ns_parser.password,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_degiro(self, other_args: List[str]):
"""Process degiro command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="degiro",
description="Set Degiro API key.",
)
parser.add_argument(
"-u",
"--username",
type=str,
dest="username",
help="username",
required="-h" not in other_args,
)
parser.add_argument(
"-p",
"--password",
type=str,
dest="password",
help="password",
required="-h" not in other_args,
)
parser.add_argument(
"-s",
"--secret",
type=str,
dest="secret",
help="TOPT Secret",
default="",
)
if not other_args:
console.print("For your API Key, visit: https://www.degiro.fr\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["degiro"] = keys_model.set_degiro_key(
username=ns_parser.username,
password=ns_parser.password,
secret=ns_parser.secret,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_oanda(self, other_args: List[str]):
"""Process oanda command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="oanda",
description="Set Oanda API key.",
)
parser.add_argument(
"-a",
"--account",
type=str,
dest="account",
help="account",
)
parser.add_argument(
"-t",
"--token",
type=str,
dest="token",
help="token",
)
parser.add_argument(
"-at",
"--account_type",
type=str,
dest="account_type",
help="account type ('live' or 'practice')",
)
if not other_args:
console.print("For your API Key, visit: https://developer.oanda.com\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["oanda"] = keys_model.set_oanda_key(
account=ns_parser.account,
access_token=ns_parser.token,
account_type=ns_parser.account_type,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_binance(self, other_args: List[str]):
"""Process binance command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="binance",
description="Set Binance API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="Key",
required="-h" not in other_args,
)
parser.add_argument(
"-s",
"--secret",
type=str,
dest="secret",
help="Secret key",
required="-h" not in other_args,
)
if not other_args:
console.print("For your API Key, visit: https://binance.com\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["binance"] = keys_model.set_binance_key(
key=ns_parser.key,
secret=ns_parser.secret,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_bitquery(self, other_args: List[str]):
"""Process bitquery command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="bitquery",
description="Set Bitquery API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://bitquery.io/\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["bitquery"] = keys_model.set_bitquery_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_si(self, other_args: List[str]):
"""Process si command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="si",
description="Set Sentiment Investor API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://sentimentinvestor.com\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["si"] = keys_model.set_si_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_coinbase(self, other_args: List[str]):
"""Process coinbase command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="coinbase",
description="Set Coinbase API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="Key",
required="-h" not in other_args,
)
parser.add_argument(
"-s",
"--secret",
type=str,
dest="secret",
help="Secret key",
required="-h" not in other_args,
)
parser.add_argument(
"-p",
"--passphrase",
type=str,
dest="passphrase",
help="Passphrase",
required="-h" not in other_args,
)
if not other_args:
console.print("For your API Key, visit: https://docs.pro.coinbase.com/\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["coinbase"] = keys_model.set_coinbase_key(
key=ns_parser.key,
secret=ns_parser.secret,
passphrase=ns_parser.passphrase,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_walert(self, other_args: List[str]):
"""Process walert command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="walert",
description="Set Whale Alert API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://docs.whale-alert.io/\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["walert"] = keys_model.set_walert_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_glassnode(self, other_args: List[str]):
"""Process glassnode command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="glassnode",
description="Set Glassnode API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["glassnode"] = keys_model.set_glassnode_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_coinglass(self, other_args: List[str]):
"""Process coinglass command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="coinglass",
description="Set Coinglass API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://coinglass.github.io/API-Reference/#api-key\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["coinglass"] = keys_model.set_coinglass_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_cpanic(self, other_args: List[str]):
"""Process cpanic command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="cpanic",
description="Set Crypto Panic API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://cryptopanic.com/developers/api/\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["cpanic"] = keys_model.set_cpanic_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_ethplorer(self, other_args: List[str]):
"""Process ethplorer command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="ethplorer",
description="Set Ethplorer API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["ethplorer"] = keys_model.set_ethplorer_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_smartstake(self, other_args: List[str]):
"""Process smartstake command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="smartstake",
description="Set Smartstake Key and Token.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="Key",
required="-h" not in other_args,
)
parser.add_argument(
"-t",
"--token",
type=str,
dest="token",
help="Token",
required="-h" not in other_args,
)
if not other_args:
console.print("For your API Key, visit: https://www.smartstake.io\n")
return
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["smartstake"] = keys_model.set_smartstake_key(
key=ns_parser.key,
access_token=ns_parser.token,
persist=True,
show_output=True,
)
@log_start_end(log=logger)
def call_github(self, other_args: List[str]):
"""Process github command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="github",
description="Set GitHub API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["github"] = keys_model.set_github_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_messari(self, other_args: List[str]):
"""Process messari command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="messari",
description="Set Messari API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://messari.io/api/docs\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["messari"] = keys_model.set_messari_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_eodhd(self, other_args: List[str]):
"""Process eodhd command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="eodhd",
description="Set End of Day Historical Data API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://eodhistoricaldata.com/r/?ref=869U7F4J\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["eodhd"] = keys_model.set_eodhd_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_santiment(self, other_args: List[str]):
"""Process santiment command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="santiment",
description="Set Santiment API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: "
"https://academy.santiment.net/products-and-plans/create-an-api-key\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["santiment"] = keys_model.set_santiment_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_shroom(self, other_args: List[str]):
"""Process shroom command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="shroom",
description="Set Shroom API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, visit: https://sdk.flipsidecrypto.xyz/shroomdk\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["shroom"] = keys_model.set_shroom_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_tokenterminal(self, other_args: List[str]):
"""Process tokenterminal command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="tokenterminal",
description="Set Token Terminal API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print("For your API Key, visit: https://tokenterminal.com/\n")
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["tokenterminal"] = keys_model.set_tokenterminal_key(
key=ns_parser.key, persist=True, show_output=True
)
@log_start_end(log=logger)
def call_stocksera(self, other_args: List[str]):
"""Process stocksera command"""
parser = argparse.ArgumentParser(
add_help=False,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog="stocksera",
description="Set Stocksera API key.",
)
parser.add_argument(
"-k",
"--key",
type=str,
dest="key",
help="key",
)
if not other_args:
console.print(
"For your API Key, https://stocksera.pythonanywhere.com/accounts/developers\n"
)
return
if other_args and "-" not in other_args[0][0]:
other_args.insert(0, "-k")
ns_parser = self.parse_simple_args(parser, other_args)
if ns_parser:
self.status_dict["stocksera"] = keys_model.set_stocksera_key(
key=ns_parser.key, persist=True, show_output=True
)