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>
33 lines
1001 B
Python
33 lines
1001 B
Python
"""`yfin lookup ...` — fuzzy symbol lookup."""
|
|
from __future__ import annotations
|
|
|
|
from enum import Enum
|
|
|
|
import typer
|
|
import yfinance as yf
|
|
|
|
from .._shared import render_via_state, get_state
|
|
|
|
|
|
class LookupType(str, Enum):
|
|
all = "all"; stock = "stock"; mutualfund = "mutualfund"; etf = "etf"
|
|
index = "index"; future = "future"; currency = "currency"; cryptocurrency = "cryptocurrency"
|
|
|
|
|
|
app = typer.Typer(no_args_is_help=True, help="Fuzzy symbol lookup.")
|
|
|
|
|
|
@app.command("run")
|
|
def lookup(
|
|
ctx: typer.Context,
|
|
query: str = typer.Argument(...),
|
|
type: LookupType = typer.Option(LookupType.all, "--type"),
|
|
count: int = typer.Option(25, "--count"),
|
|
raise_errors: bool = typer.Option(True, "--raise-errors/--no-raise-errors"),
|
|
):
|
|
"""Resolve a query to candidate symbols (one asset class)."""
|
|
st = get_state(ctx)
|
|
L = yf.Lookup(query, timeout=st.timeout, raise_errors=raise_errors)
|
|
fn = getattr(L, f"get_{type.value}")
|
|
render_via_state(ctx, fn(count=count))
|