goldyard
057bc4493e
Wraps the entire yfinance public API behind a single binary `yfin` with
51 subcommands across 13 namespaces (ticker, download, tickers, search,
lookup, market, sector, industry, calendars, screen, live, auth, config).
Output renders as Rich tables on TTY, JSON when piped; --format / --out
support table | json | ndjson | csv | tsv | parquet | yaml.
Highlights:
- 1857 LOC across 18 Python files under cli/yfin/
- Typer + Rich, packaged via hatchling + uv
- Install globally: `cd cli && uv tool install -e .`
- ~/.yfin/config.toml for persistent proxy/cookies/locale defaults
- Friendly YFRateLimitError handler (exit 2, no Rich traceback)
- Validated end-to-end with 33 live tests against Yahoo from a
residential exit (AAPL, MSFT, NVDA, options, screens, calendars,
financials, news, holders, parquet round-trip)
yfinance-tools.yaml is the single source of truth:
- tools (49) — every public yfinance entry point with parameters
- cli (13 groups) — exact CLI invocations, mapped back to tool names
- outputSchemas (27) — actual return shapes captured from live calls
- learnings (19) — IP rate-limit, crumb handshake, Typer gotchas,
screen-build wrapping rules, upstream stubs, etc.
CLAUDE.md documents the upstream codebase layout for future agents.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
37 lines
1.2 KiB
Python
37 lines
1.2 KiB
Python
"""`yfin market ...` — region-level overview / status."""
|
|
from __future__ import annotations
|
|
|
|
from enum import Enum
|
|
|
|
import typer
|
|
import yfinance as yf
|
|
|
|
from .._shared import render_via_state, get_state
|
|
|
|
|
|
class Region(str, Enum):
|
|
US = "US"; GB = "GB"; ASIA = "ASIA"; EUROPE = "EUROPE"
|
|
RATES = "RATES"; COMMODITIES = "COMMODITIES"
|
|
CURRENCIES = "CURRENCIES"; CRYPTOCURRENCIES = "CRYPTOCURRENCIES"
|
|
|
|
|
|
app = typer.Typer(no_args_is_help=True, help="Region-level market overview / status.")
|
|
|
|
|
|
@app.command("summary")
|
|
def summary(ctx: typer.Context, region: Region = typer.Argument(...)):
|
|
"""All exchanges/indices Yahoo tracks for this region."""
|
|
st = get_state(ctx)
|
|
render_via_state(ctx, yf.Market(region.value, timeout=st.timeout).summary)
|
|
|
|
|
|
@app.command("status")
|
|
def status(ctx: typer.Context, region: Region = typer.Argument(...)):
|
|
"""Open/closed + open/close times + tz."""
|
|
st = get_state(ctx)
|
|
s = yf.Market(region.value, timeout=st.timeout).status
|
|
# Status carries datetime objects; coerce for JSON safety.
|
|
if isinstance(s, dict):
|
|
s = {k: (v.isoformat() if hasattr(v, "isoformat") else v) for k, v in s.items()}
|
|
render_via_state(ctx, s)
|