mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +00:00
58d2ea1637
* token generation on the terminal * revoke and show commands * auto login on the sdk if local session is found * fix tests --------- Co-authored-by: Luqman <luqazino@gmail.com> Co-authored-by: James Maslek <jmaslek11@gmail.com>
101 lines
2.6 KiB
Python
101 lines
2.6 KiB
Python
import logging
|
|
|
|
from openbb_terminal.decorators import log_start_end
|
|
from openbb_terminal.rich_config import console
|
|
from openbb_terminal.session import (
|
|
local_model as Local,
|
|
session_model,
|
|
)
|
|
from openbb_terminal.session.user import User
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def get_session(email: str, password: str, token: str, save: bool):
|
|
session = ""
|
|
|
|
if token:
|
|
console.print("Creating session from token.")
|
|
session = session_model.create_session_from_token(token, save) # type: ignore
|
|
|
|
if not session and email:
|
|
console.print("Creating session from email and password.")
|
|
session = session_model.create_session(email, password, save) # type: ignore
|
|
|
|
if not (isinstance(session, dict) and session):
|
|
raise Exception("Failed to create session.")
|
|
|
|
return session
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def login(
|
|
email: str = "", password: str = "", token: str = "", keep_session: bool = False
|
|
):
|
|
"""
|
|
Login and load user info.
|
|
If there is a saved session it will be used (this can be achieved by `keep_session=True`).
|
|
If there's not a local session,
|
|
the user can use either email and password or the OpenBB Personal Access Token.
|
|
|
|
Parameters
|
|
----------
|
|
email : str
|
|
The email.
|
|
password : str
|
|
The password.
|
|
token : str
|
|
The OpenBB Personal Access Token.
|
|
keep_session : bool
|
|
Keep the session, i.e., next time the user logs in,
|
|
there is no need to enter the email and password or the token.
|
|
|
|
Examples
|
|
--------
|
|
>>> from openbb_terminal.sdk import openbb
|
|
>>> openbb.login(email="your_email", password="your_password")
|
|
"""
|
|
if not (email or token):
|
|
session = Local.get_session()
|
|
|
|
if not session:
|
|
session = get_session(email, password, token, keep_session)
|
|
else:
|
|
console.print("Using local session to login.")
|
|
|
|
status = session_model.login(session)
|
|
if status != session_model.LoginStatus.SUCCESS:
|
|
raise Exception(f"Login failed with status `{status.value}`.")
|
|
|
|
console.print("[green]Login successful.[/green]")
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def logout():
|
|
"""
|
|
Logout and clear session.
|
|
|
|
Examples
|
|
--------
|
|
>>> from openbb_terminal.sdk import openbb
|
|
>>> openbb.logout()
|
|
"""
|
|
session_model.logout(
|
|
auth_header=User.get_auth_header(),
|
|
token=User.get_token(),
|
|
guest=User.is_guest(),
|
|
)
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def whoami():
|
|
"""
|
|
Display user info.
|
|
|
|
Examples
|
|
--------
|
|
>>> from openbb_terminal.sdk import openbb
|
|
>>> openbb.whoami()
|
|
"""
|
|
User.whoami()
|