yfin-cli 0.1.1__py3-none-any.whl

src/utils.py

@@ -0,0 +1,91 @@
+import json
+import typer
+from typing import Any, Callable
+from datetime import datetime, timedelta
+from pandas import DataFrame, Series
+from rich.console import Console
+
+console = Console()
+
+
+def console_print(content: Any):
+    console.print(content)
+
+
+def console_print_error(content: Any):
+    console.print(f"[red]{content}[/red]")
+
+
+def console_print_warning(content: Any):
+    console.print(f"[yellow]{content}[/yellow]")
+
+
+def count_specified(*args: str | None) -> int:
+    """Count the number of specified arguments"""
+    return sum(x is not None for x in args)
+
+
+def compact(**kwargs):
+    """Return a dict with None values removed."""
+    return {k: v for k, v in kwargs.items() if v is not None}
+
+
+def get_today_date_string() -> str:
+    return format_datetime(datetime.now())
+
+
+def default_end_from_start(start: str, end: str | None) -> str:
+    if end is not None:
+        return end
+    start_date = datetime.strptime(start, "%Y-%m-%d")
+    return format_datetime(start_date + timedelta(days=7))
+
+
+def format_datetime(val: datetime) -> str:
+    return val.strftime("%Y-%m-%d")
+
+
+def is_number(s: str) -> bool:
+    try:
+        float(s)
+        return True
+    except ValueError:
+        return False
+
+
+def data_frame_to_list(data_frame: DataFrame, index_name: str | None = None) -> list:
+    if data_frame is None:
+        return None
+    return json.loads(
+        data_frame.reset_index(names=index_name).to_json(
+            orient="records", date_format="iso"
+        )
+    )
+
+
+def series_to_list(series: Series) -> list:
+    if series is None:
+        return None
+    return json.loads(series.reset_index().to_json(orient="records", date_format="iso"))
+
+
+def validate_value_in_list(valid_values: list[str]) -> Callable[[str], str]:
+    def _validator(x: str) -> str:
+        if x in valid_values:
+            return x
+        raise typer.BadParameter(
+            f"Invalid value: {x}, should be one of {', '.join(valid_values)}"
+        )
+
+    return _validator
+
+
+def validate_date_string(value: str) -> str:
+    """Validate date string format (YYYY-MM-DD)"""
+    try:
+        if len(value) != 10:
+            raise ValueError()
+        datetime.strptime(value, "%Y-%m-%d")
+        return value
+    except ValueError:
+        raise typer.BadParameter(f"Invalid date format: {value}. Use YYYY-MM-DD")

src/writer.py

@@ -0,0 +1,43 @@
+import json
+from typing import Protocol
+from rich.table import Table
+from .utils import console_print
+
+
+class OutputWriter(Protocol):
+    def write(self, data: dict | list) -> None: ...
+
+
+class WriterFactory:
+    @staticmethod
+    def get_writer(writer_type: str) -> OutputWriter:
+        if writer_type == "json":
+            return JsonWriter()
+        if writer_type == "table":
+            return TableWriter()
+        raise ValueError(f"Unsupported writer type: {writer_type}")
+
+
+class JsonWriter(OutputWriter):
+    def write(self, data: dict | list) -> None:
+        console_print(json.dumps(data, indent=2, default=str))
+
+
+class TableWriter(OutputWriter):
+    def write(self, data: dict | list) -> None:
+        table = Table(header_style="bold cyan")
+
+        if isinstance(data, dict):
+            data = [data]
+
+        if len(data) == 0:
+            console_print(table)
+            return
+
+        for key, value in data[0].items():
+            table.add_column(key)
+
+        for record in data:
+            table.add_row(*[str(value) for value in record.values()])
+
+        console_print(table)

yfin_cli-0.1.1.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: yfin-cli
+Version: 0.1.1
+Summary: A command-line interface for Yahoo Finance data
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: lxml>=6.0.2
+Requires-Dist: rich>=14.2.0
+Requires-Dist: typer>=0.21.1
+Requires-Dist: yfinance>=1.1.0
+Description-Content-Type: text/markdown
+
+# yfin-cli
+
+A command-line interface for Yahoo Finance data, powered by [yfinance](https://github.com/ranaroussi/yfinance).
+
+## Why yfin-cli
+
+- Fast, scriptable access to Yahoo Finance data.
+- JSON or table output for easy piping.
+- Broad coverage: prices, financials, analyst data, screeners, sectors, industries.
+
+## Install
+
+Requires Python 3.10+.
+
+### From PyPI (recommended)
+
+```bash
+pipx install yfin-cli
+# or
+pip install yfin-cli
+# or
+uv tool install yfin-cli
+```
+
+### From source
+
+```bash
+git clone <your-repo-url>
+cd yfin-cli
+uv tool install .
+# or
+pip install .
+```
+
+## Usage
+
+### Quickstart
+
+```bash
+# Get historical stock data
+yfin history AAPL
+
+# Get quick summary metrics
+yfin fast-info TSLA
+
+# Check market status
+yfin market-status
+
+# View quarterly income statement
+yfin income-stmt MSFT --frequency quarterly
+
+# Get analyst recommendations
+yfin recommendations NVDA
+
+# Screen stocks
+yfin screen --filter "sector eq Technology" --filter "intradaymarketcap gt 100000000000"
+
+# Use a predefined screener
+yfin screen --predefined day_gainers
+
+# Output as a table
+yfin --output table history AAPL --period 1y
+```
+
+> For the complete command reference with all options and parameters, see [COMMANDS.md](COMMANDS.md).
+
+### Global options:
+
+| Option     | Description                     | Default |
+| ---------- | ------------------------------- | ------- |
+| `--output` | Output format (`json`, `table`) | `json`  |
+| `--help`   | Show help message               | —       |
+
+## Available Commands
+
+| Category       | Commands                                                                                                                                                                 |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **Stock**      | `history`, `dividends`, `fast-info`, `news`                                                                                                                              |
+| **Market**     | `market-status`                                                                                                                                                          |
+| **Calendar**   | `calendar-earnings`, `calendar-economic-events`, `calendar-ipo`                                                                                                          |
+| **Financials** | `income-stmt`, `balance-sheet`, `cashflow`, `earnings-dates`, `sec-filings`                                                                                              |
+| **Analysis**   | `recommendations`, `upgrades-downgrades`, `price-targets`, `earnings-estimate`, `revenue-estimate`, `earnings-history`, `eps-trend`, `eps-revisions`, `growth-estimates` |
+| **Holders**    | `insider-purchases`, `insider-transactions`, `insider-roster-holders`, `major-holders`, `institutional-holders`, `mutualfund-holders`                                    |
+| **Sector**     | `sector-keys`, `sector-industries`, `sector-overview`, `sector-research-reports`, `sector-top-companies`, `sector-top-etfs`, `sector-top-mutual-funds`                   |
+| **Industry**   | `industry-overview`, `industry-research-reports`, `industry-top-companies`, `industry-top-growth-companies`, `industry-top-performing-companies`                         |
+| **Screen**     | `screen`, `screen-query-fields`, `screen-query-values`, `screen-predefined-queries`                                                                                      |
+
+## Development
+
+This project uses uv for dependency management.
+
+```bash
+# Install dependencies
+uv sync
+
+# Run the CLI
+uv run yfin --help
+
+# Run tests
+uv run pytest
+
+# Format code
+uv run ruff format .
+
+# Build package
+uv build
+```
+
+## License
+
+MIT

yfin_cli-0.1.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+src/__init__.py,sha256=-aMOnBZnHvEG2-LRhGUjTFdQae8v9izcodgdi7Ycq8E,49
+src/cli.py,sha256=cvoI9BMRnXxwg-bjjdhu3lZxNzt7j2iukvZ58b-RLUo,4243
+src/decorators.py,sha256=dDWAyhQpGStIGK1lOHbAPNEUBja6J5Fpfd3J0cFGg28,1030
+src/typer.py,sha256=-_6iu6-6WuuPOJZLJfEa6n3EBdR0VevE2Oic2sNsFp0,4687
+src/utils.py,sha256=i55BB3R0kV5RMt3iaLe-VMIzjANZLSfG4lEVKbPDfiM,2321
+src/writer.py,sha256=2o_CBC-Zhis5vGAE_xzJMCk25xoWou_RkAkkwJjvA6c,1108
+src/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/commands/analysis.py,sha256=9adDjdOZsYARk6EmXYIuZtDZ8VnlOWVK8vo9-rW-dtg,3753
+src/commands/calendar.py,sha256=x2iXVyMIu6i_-VmFnrLzt8uHpkML-tseXRFJAK0ChII,1900
+src/commands/financials.py,sha256=Ffc9a0PCSE61-c34QWWluIikRS5QLdeRuqpeMikhy6E,1922
+src/commands/industry.py,sha256=2yPy8-UfFd7htvCZy81lIDaGDQ4f6UW-UKR9LNZ5nJ8,1083
+src/commands/market.py,sha256=jomhVsXGTIIjTvJkJr8YtQ7CJpi4GQjPLkKlZb7A2V8,187
+src/commands/screen.py,sha256=UDKkJzDYJMJBcc5pHKDPZiy9UZcmL-gi_A7Cdhnrgik,8884
+src/commands/sector.py,sha256=hXQTxMOdCgtGUqxOVMjARgwxL0-8pEQALgvs2U0qiDQ,1442
+src/commands/stock.py,sha256=tbaYNx0kqXbKVOuUAJTwLUGSQI0uHVKt0Suc5dsN5Jc,2706
+yfin_cli-0.1.1.dist-info/METADATA,sha256=63mEwvQKOkQBPpn0u7afjwFaBTS8EU1NKd640uQN5nM,4187
+yfin_cli-0.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+yfin_cli-0.1.1.dist-info/entry_points.txt,sha256=AeTQvaF0pSSs34VdOcoGsJ_-Fjb47cPbhjO65l46aDg,37
+yfin_cli-0.1.1.dist-info/licenses/LICENSE,sha256=k22ZS3asvWad8Mv9mA1YBc5zg7K0t5Ip94gQWIfpxR0,1065
+yfin_cli-0.1.1.dist-info/RECORD,,

yfin_cli-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

yfin_cli-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+yfin = src.cli:app

yfin_cli-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rayyamhk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.