summaryrefslogtreecommitdiffstats
path: root/openbb_terminal/cryptocurrency/discovery/cryptostats_view.py
blob: 6cb03aceeb19a577ecbce63cb715226bb713ec1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
"""CryptoStats view"""
__docformat__ = "numpy"

import logging
import os
from typing import Optional

from openbb_terminal.cryptocurrency.discovery import cryptostats_model
from openbb_terminal.decorators import log_start_end
from openbb_terminal.helper_funcs import export_data, print_rich_table
from openbb_terminal.rich_config import console

logger = logging.getLogger(__name__)


@log_start_end(log=logger)
def display_fees(
    marketcap: bool,
    tvl: bool,
    date: str,
    limit: int = 15,
    sortby: str = "",
    ascend: bool = True,
    sheet_name: Optional[str] = None,
    export: str = "",
) -> None:
    """Display crypto with most fees paid [Source: CryptoStats]

    Parameters
    ----------
    marketcap: bool
        Flag to include marketcap
    date: str
        Date to get data from (YYYY-MM-DD)
    limit: int
        Number of records to display
    sortby: str
        Key to sort data.
    ascend: bool
        Flag to sort data ascending
    export : str
        Export dataframe data to csv,json,xlsx file
    """

    df = cryptostats_model.get_fees(marketcap, tvl, date)

    if df.empty:
        console.print("No Data Found\n")
        return

    if sortby:
        df = df.sort_values(sortby, ascending=ascend)

    if "One Day Fees" in df.columns:
        one_day_fees = df.pop("One Day Fees").map(lambda x: f"{x:,.2f}")
        df.insert(len(df.columns), "One Day Fees", one_day_fees)

    print_rich_table(
        df,
        headers=list(df.columns),
        show_index=False,
        title="Crypto Fees",
        limit=limit,
    )

    export_data(
        export, os.path.dirname(os.path.abspath(__file__)), "fees", df, sheet_name
    )