yfin-cli 0.1.1__py3-none-any.whl

src/__init__.py

@@ -0,0 +1 @@
+# yfin CLI - A command-line wrapper for yfinance

src/cli.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+"""
+yfin CLI - A command-line tool for Yahoo Finance data
+"""
+
+import typer
+from .typer import OutputType, default_output
+from .commands.stock import (
+    history,
+    dividends,
+    fast_info,
+    news,
+)
+from .commands.market import market_status
+from .commands.calendar import (
+    calendar_earnings,
+    calendar_economic_events,
+    calendar_ipo,
+)
+from .commands.financials import (
+    income_stmt,
+    balance_sheet,
+    cashflow,
+    earnings_dates,
+    sec_filings,
+)
+from .commands.analysis import (
+    recommendations,
+    upgrades_downgrades,
+    price_targets,
+    earnings_estimate,
+    revenue_estimate,
+    earnings_history,
+    eps_trend,
+    eps_revisions,
+    growth_estimates,
+    insider_purchases,
+    insider_transactions,
+    insider_roster_holders,
+    major_holders,
+    institutional_holders,
+    mutualfund_holders,
+)
+from .commands.sector import (
+    sector_keys,
+    sector_industries,
+    sector_overview,
+    sector_research_reports,
+    sector_top_companies,
+    sector_top_etfs,
+    sector_top_mutual_funds,
+)
+from .commands.industry import (
+    industry_overview,
+    industry_research_reports,
+    industry_top_companies,
+    industry_top_growth_companies,
+    industry_top_performing_companies,
+)
+from .commands.screen import (
+    screen,
+    screen_query_fields,
+    screen_query_values,
+    screen_predefined_queries,
+)
+
+app = typer.Typer(
+    name="yfin",
+    help="A command-line interface for Yahoo Finance data",
+    no_args_is_help=True,
+)
+
+
+@app.callback()
+def main(ctx: typer.Context, output: OutputType = default_output):
+    ctx.ensure_object(dict)
+    ctx.obj["output"] = output
+
+
+app.command(rich_help_panel="Stock")(history)
+app.command(rich_help_panel="Stock")(dividends)
+app.command(rich_help_panel="Stock")(fast_info)
+app.command(rich_help_panel="Stock")(news)
+
+app.command(rich_help_panel="Market")(market_status)
+
+app.command(rich_help_panel="Calendar")(calendar_earnings)
+app.command(rich_help_panel="Calendar")(calendar_economic_events)
+app.command(rich_help_panel="Calendar")(calendar_ipo)
+
+app.command(rich_help_panel="Financials")(income_stmt)
+app.command(rich_help_panel="Financials")(balance_sheet)
+app.command(rich_help_panel="Financials")(cashflow)
+app.command(rich_help_panel="Financials")(earnings_dates)
+app.command(rich_help_panel="Financials")(sec_filings)
+
+app.command(rich_help_panel="Analysis")(recommendations)
+app.command(rich_help_panel="Analysis")(upgrades_downgrades)
+app.command(rich_help_panel="Analysis")(price_targets)
+app.command(rich_help_panel="Analysis")(earnings_estimate)
+app.command(rich_help_panel="Analysis")(revenue_estimate)
+app.command(rich_help_panel="Analysis")(earnings_history)
+app.command(rich_help_panel="Analysis")(eps_trend)
+app.command(rich_help_panel="Analysis")(eps_revisions)
+app.command(rich_help_panel="Analysis")(growth_estimates)
+app.command(rich_help_panel="Analysis")(insider_purchases)
+app.command(rich_help_panel="Analysis")(insider_transactions)
+app.command(rich_help_panel="Analysis")(insider_roster_holders)
+app.command(rich_help_panel="Analysis")(major_holders)
+app.command(rich_help_panel="Analysis")(institutional_holders)
+app.command(rich_help_panel="Analysis")(mutualfund_holders)
+
+app.command(rich_help_panel="Sector")(sector_keys)
+app.command(rich_help_panel="Sector")(sector_industries)
+app.command(rich_help_panel="Sector")(sector_overview)
+app.command(rich_help_panel="Sector")(sector_research_reports)
+app.command(rich_help_panel="Sector")(sector_top_companies)
+app.command(rich_help_panel="Sector")(sector_top_etfs)
+app.command(rich_help_panel="Sector")(sector_top_mutual_funds)
+
+app.command(rich_help_panel="Industry")(industry_overview)
+app.command(rich_help_panel="Industry")(industry_research_reports)
+app.command(rich_help_panel="Industry")(industry_top_companies)
+app.command(rich_help_panel="Industry")(industry_top_growth_companies)
+app.command(rich_help_panel="Industry")(industry_top_performing_companies)
+
+app.command(rich_help_panel="Screen")(screen)
+app.command(rich_help_panel="Screen")(screen_query_fields)
+app.command(rich_help_panel="Screen")(screen_query_values)
+app.command(rich_help_panel="Screen")(screen_predefined_queries)
+
+if __name__ == "__main__":
+    app()

src/commands/analysis.py

@@ -0,0 +1,153 @@
+import yfinance as yf
+from ..typer import TickerType
+from ..decorators import command
+from ..utils import data_frame_to_list
+
+
+@command
+def recommendations(ticker: TickerType):
+    """
+    Get analyst recommendations for a stock ticker: number of buy, sell and hold in different time periods.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_recommendations()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def upgrades_downgrades(ticker: TickerType):
+    """
+    Get the analyst upgrades and downgrades history for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_upgrades_downgrades()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def price_targets(ticker: TickerType):
+    """
+    Get the analyst price targets for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    return stock.get_analyst_price_targets()
+
+
+@command
+def earnings_estimate(ticker: TickerType):
+    """
+    Get analyst earnings estimate for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_earnings_estimate()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def revenue_estimate(ticker: TickerType):
+    """
+    Get analyst revenue estimate for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_revenue_estimate()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def earnings_history(ticker: TickerType):
+    """
+    Get analyst earnings history for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_earnings_history()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def eps_trend(ticker: TickerType):
+    """
+    Get analyst eps trend for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_eps_trend()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def eps_revisions(ticker: TickerType):
+    """
+    Get analyst eps revisions for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_eps_revisions()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def growth_estimates(ticker: TickerType):
+    """
+    Get analyst growth estimates for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_growth_estimates()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def insider_purchases(ticker: TickerType):
+    """
+    Get insider purchases for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_insider_purchases()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def insider_transactions(ticker: TickerType):
+    """
+    Get insider transactions for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_insider_transactions()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def insider_roster_holders(ticker: TickerType):
+    """
+    Get insider roster holders for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_insider_roster_holders()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def major_holders(ticker: TickerType):
+    """
+    Get major holders for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_major_holders()
+    return data_frame_to_list(data_frame, index_name="Breakdown")
+
+
+@command
+def institutional_holders(ticker: TickerType):
+    """
+    Get institutional holders for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_institutional_holders()
+    return data_frame_to_list(data_frame)
+
+
+@command
+def mutualfund_holders(ticker: TickerType):
+    """
+    Get mutual fund holders for a stock ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_mutualfund_holders()
+    return data_frame_to_list(data_frame)

src/commands/calendar.py

@@ -0,0 +1,84 @@
+import yfinance as yf
+from ..typer import (
+    StartDateType,
+    EndDateType,
+    LimitType,
+    default_limit,
+    OffsetType,
+    default_offset,
+    MarketCapType,
+    default_market_cap,
+)
+from ..decorators import command
+from ..utils import compact, data_frame_to_list, default_end_from_start
+
+
+@command
+def calendar_earnings(
+    start: StartDateType,
+    end: EndDateType = None,
+    limit: LimitType = default_limit,
+    offset: OffsetType = default_offset,
+    market_cap: MarketCapType = default_market_cap,
+):
+    """
+    Get earnings calendar.
+    """
+    end = default_end_from_start(start, end)
+    kwargs = compact(
+        limit=limit,
+        offset=offset,
+        start=start,
+        end=end,
+        market_cap=market_cap,
+    )
+
+    calendars = yf.Calendars()
+    data_frame = calendars.get_earnings_calendar(**kwargs)
+    return data_frame_to_list(data_frame)
+
+
+@command
+def calendar_economic_events(
+    start: StartDateType,
+    end: EndDateType = None,
+    limit: LimitType = default_limit,
+    offset: OffsetType = default_offset,
+):
+    """
+    Get economic events calendar.
+    """
+    end = default_end_from_start(start, end)
+    kwargs = compact(
+        limit=limit,
+        offset=offset,
+        start=start,
+        end=end,
+    )
+
+    calendars = yf.Calendars()
+    data_frame = calendars.get_economic_events_calendar(**kwargs)
+    return data_frame_to_list(data_frame)
+
+
+@command
+def calendar_ipo(
+    start: StartDateType,
+    end: EndDateType = None,
+    limit: LimitType = default_limit,
+    offset: OffsetType = default_offset,
+):
+    """
+    Get IPO calendar.
+    """
+    end = default_end_from_start(start, end)
+    kwargs = compact(
+        limit=limit,
+        offset=offset,
+        start=start,
+        end=end,
+    )
+
+    calendars = yf.Calendars()
+    data_frame = calendars.get_ipo_info_calendar(**kwargs)
+    return data_frame_to_list(data_frame)

src/commands/financials.py

@@ -0,0 +1,83 @@
+import yfinance as yf
+from ..typer import (
+    TickerType,
+    FrequencyType,
+    ExtendedFrequencyType,
+    default_frequency,
+    OffsetType,
+    default_offset,
+    LimitType,
+    default_limit,
+)
+from ..utils import data_frame_to_list
+from ..decorators import command
+
+
+@command
+def income_stmt(
+    ticker: TickerType,
+    frequency: ExtendedFrequencyType = default_frequency,
+):
+    """
+    Get income statement for a ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_income_stmt(pretty=True, freq=frequency)
+    if data_frame is None:
+        return None
+    return data_frame_to_list(data_frame.T, index_name="Date")
+
+
+@command
+def balance_sheet(
+    ticker: TickerType,
+    frequency: FrequencyType = default_frequency,
+):
+    """
+    Get balance sheet for a ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_balance_sheet(pretty=True, freq=frequency)
+    if data_frame is None:
+        return None
+    return data_frame_to_list(data_frame.T, index_name="Date")
+
+
+@command
+def cashflow(
+    ticker: TickerType,
+    frequency: ExtendedFrequencyType = default_frequency,
+):
+    """
+    Get cash flow statement for a ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_cashflow(pretty=True, freq=frequency)
+    if data_frame is None:
+        return None
+    return data_frame_to_list(data_frame.T, index_name="Date")
+
+
+@command
+def earnings_dates(
+    ticker: TickerType,
+    limit: LimitType = default_limit,
+    offset: OffsetType = default_offset,
+):
+    """
+    Get earnings dates, estimates, and reported EPS for a ticker.
+    """
+    stock = yf.Ticker(ticker)
+    data_frame = stock.get_earnings_dates(limit=limit, offset=offset)
+    return data_frame_to_list(data_frame)
+
+
+@command
+def sec_filings(
+    ticker: TickerType,
+):
+    """
+    Get SEC filings for a ticker.
+    """
+    stock = yf.Ticker(ticker)
+    return stock.get_sec_filings()

src/commands/industry.py

@@ -0,0 +1,44 @@
+import yfinance as yf
+from ..typer import IndustryKeyType
+from ..decorators import command
+from ..utils import data_frame_to_list
+
+
+@command
+def industry_overview(key: IndustryKeyType):
+    """
+    Get the overview information of the domain entity.
+    """
+    return yf.Industry(key).overview
+
+
+@command
+def industry_research_reports(key: IndustryKeyType):
+    """
+    Get research reports related to the domain entity.
+    """
+    return yf.Industry(key).research_reports
+
+
+@command
+def industry_top_companies(key: IndustryKeyType):
+    """
+    Get the top companies within the domain entity.
+    """
+    return data_frame_to_list(yf.Industry(key).top_companies)
+
+
+@command
+def industry_top_growth_companies(key: IndustryKeyType):
+    """
+    Get the top growth companies in the industry.
+    """
+    return data_frame_to_list(yf.Industry(key).top_growth_companies)
+
+
+@command
+def industry_top_performing_companies(key: IndustryKeyType):
+    """
+    Get the top performing companies in the industry.
+    """
+    return data_frame_to_list(yf.Industry(key).top_performing_companies)

src/commands/market.py

@@ -0,0 +1,11 @@
+import yfinance as yf
+from ..decorators import command
+
+
+@command
+def market_status():
+    """
+    Get the US market status.
+    """
+    market = yf.Market("US")
+    return market.status