py-yfinance 0.1.0__tar.gz

py_yfinance-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+        
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+        
+      - name: Run tests
+        run: uv run pytest
+        
+      - name: Lint with Ruff
+        run: uv run ruff check .

py_yfinance-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/py-yfinance
+    permissions:
+      id-token: write
+      
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.13
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish

py_yfinance-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

py_yfinance-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Roman Medvedev
+
+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.

py_yfinance-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+global-exclude *.py[cod]
+global-include *.typed

py_yfinance-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: py-yfinance
+Version: 0.1.0
+Summary: A structured Python interface for retrieving and validating market data using yfinance
+Project-URL: Homepage, https://github.com/romamo/py-yfinance
+Project-URL: Repository, https://github.com/romamo/py-yfinance
+Project-URL: Issues, https://github.com/romamo/py-yfinance/issues
+Author-email: Roman Medvedev <pypi@romavm.dev>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: pycountry>=24.6.1
+Requires-Dist: pydantic-market-data>=0.1.0
+Requires-Dist: yfinance>=1.0
+Provides-Extra: cli
+Requires-Dist: typer; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# py-yfinance
+
+A structured Python interface for retrieving and validating market data using `yfinance`.
+Implements the `DataSource` protocol from `pydantic-market-data` to provide type-safe security resolution and historical data fetching.
+
+## Features
+
+- **Protocol-Oriented**: Implements `DataSource` interface.
+- **Security Resolution**: Resolve ISINs and Symbols to valid `yfinance` tickers.
+- **Validation**:
+  - **Exchanges**: Map exchanges (e.g., `IBIS`, `AEB`) to Yahoo suffixes (`.DE`, `.AS`).
+  - **Price Validation**: Verify tickers against a known target price with **strict 1% tolerance**.
+  - **Date Validation**: Validate prices on specific historical dates.
+- **Typer CLI**: Optional command-line interface for lookup and history.
+
+## Installation
+
+```bash
+# Basic installation
+uv pip install py-yfinance
+
+# With CLI support
+uv pip install "py-yfinance[cli]"
+```
+
+## Usage
+
+### As a Library
+
+```python
+from py_yfinance.source import YFinanceDataSource
+from pydantic_market_data.models import SecurityCriteria
+
+source = YFinanceDataSource()
+
+# 1. Simple Lookup by Symbol
+criteria = SecurityCriteria(symbol="AAPL", preferred_exchanges=["NASDAQ"])
+result = source.resolve(criteria)
+print(result)
+# Symbol(ticker='AAPL', name='Apple Inc.', exchange='NMS', currency='USD', ...)
+
+# 2. Strict Validation using Date & Price
+# Useful for verifying ISIN mappings or ensuring data quality
+criteria = SecurityCriteria(
+    isin="NL0010273215",
+    target_date="2025-12-15",
+    target_price=923.4  # Validates against history with 1% tolerance
+)
+match = source.resolve(criteria)
+if match:
+    print(f"Verified: {match.ticker}")
+else:
+    print("Validation failed: Price mismatch or symbol not found")
+```
+
+### CLI Usage
+
+Requires `[cli]` extra.
+
+#### Lookup
+Resolve a security by Symbol or ISIN.
+
+```bash
+# Basic Lookup
+uv run py-yfinance lookup --symbol AAPL
+
+# ISIN Lookup with Strict Validation
+# Verifies that NL0010273215 commanded a price of ~923.4 on 2025-12-15
+uv run py-yfinance lookup --isin NL0010273215 --date 2025-12-15 --price 923.4
+```
+
+#### History
+Fetch historical candles.
+
+```bash
+uv run py-yfinance history AAPL --period 5d
+```
+
+## Development
+
+This project uses `uv` for dependency management.
+
+```bash
+# Sync dependencies
+uv sync --extra cli
+
+# Run Tests
+uv run pytest
+```
+
+## License
+
+MIT

py_yfinance-0.1.0/README.md

@@ -0,0 +1,93 @@
+# py-yfinance
+
+A structured Python interface for retrieving and validating market data using `yfinance`.
+Implements the `DataSource` protocol from `pydantic-market-data` to provide type-safe security resolution and historical data fetching.
+
+## Features
+
+- **Protocol-Oriented**: Implements `DataSource` interface.
+- **Security Resolution**: Resolve ISINs and Symbols to valid `yfinance` tickers.
+- **Validation**:
+  - **Exchanges**: Map exchanges (e.g., `IBIS`, `AEB`) to Yahoo suffixes (`.DE`, `.AS`).
+  - **Price Validation**: Verify tickers against a known target price with **strict 1% tolerance**.
+  - **Date Validation**: Validate prices on specific historical dates.
+- **Typer CLI**: Optional command-line interface for lookup and history.
+
+## Installation
+
+```bash
+# Basic installation
+uv pip install py-yfinance
+
+# With CLI support
+uv pip install "py-yfinance[cli]"
+```
+
+## Usage
+
+### As a Library
+
+```python
+from py_yfinance.source import YFinanceDataSource
+from pydantic_market_data.models import SecurityCriteria
+
+source = YFinanceDataSource()
+
+# 1. Simple Lookup by Symbol
+criteria = SecurityCriteria(symbol="AAPL", preferred_exchanges=["NASDAQ"])
+result = source.resolve(criteria)
+print(result)
+# Symbol(ticker='AAPL', name='Apple Inc.', exchange='NMS', currency='USD', ...)
+
+# 2. Strict Validation using Date & Price
+# Useful for verifying ISIN mappings or ensuring data quality
+criteria = SecurityCriteria(
+    isin="NL0010273215",
+    target_date="2025-12-15",
+    target_price=923.4  # Validates against history with 1% tolerance
+)
+match = source.resolve(criteria)
+if match:
+    print(f"Verified: {match.ticker}")
+else:
+    print("Validation failed: Price mismatch or symbol not found")
+```
+
+### CLI Usage
+
+Requires `[cli]` extra.
+
+#### Lookup
+Resolve a security by Symbol or ISIN.
+
+```bash
+# Basic Lookup
+uv run py-yfinance lookup --symbol AAPL
+
+# ISIN Lookup with Strict Validation
+# Verifies that NL0010273215 commanded a price of ~923.4 on 2025-12-15
+uv run py-yfinance lookup --isin NL0010273215 --date 2025-12-15 --price 923.4
+```
+
+#### History
+Fetch historical candles.
+
+```bash
+uv run py-yfinance history AAPL --period 5d
+```
+
+## Development
+
+This project uses `uv` for dependency management.
+
+```bash
+# Sync dependencies
+uv sync --extra cli
+
+# Run Tests
+uv run pytest
+```
+
+## License
+
+MIT

py_yfinance-0.1.0/examples/demo_resolve.py

@@ -0,0 +1,34 @@
+from pydantic_market_data.models import SecurityCriteria
+
+from py_yfinance.source import YFinanceDataSource
+
+
+def main():
+    source = YFinanceDataSource()
+
+    scenarios = [
+        {"symbol": "AAPL", "desc": "Simple US Stock"},
+        {"symbol": "4GLD", "exchanges": ["IBIS"], "desc": "German ETF (needs .DE suffix)"},
+        {"symbol": "ASML", "exchanges": ["AEB"], "desc": "Dutch Stock"},
+        {"symbol": "INVALID123", "desc": "Non-existent ticker"},
+    ]
+
+    print(f"{'Description':<30} | {'Input':<15} | {'Resolved Ticker':<15} | {'Name'}")
+    print("-" * 90)
+
+    for s in scenarios:
+        criteria = SecurityCriteria(symbol=s["symbol"], preferred_exchanges=s.get("exchanges"))
+        result = source.resolve(criteria)
+
+        input_str = s["symbol"]
+        if s.get("exchanges"):
+            input_str += f" ({s['exchanges'][0]})"
+
+        ticker = result.ticker if result else "N/A"
+        name = result.name if result else "-"
+
+        print(f"{s['desc']:<30} | {input_str:<15} | {ticker:<15} | {name}")
+
+
+if __name__ == "__main__":
+    main()

py_yfinance-0.1.0/examples/portseido_parser.py

@@ -0,0 +1,67 @@
+import sys
+import xml.etree.ElementTree as ET
+
+from pydantic_market_data.models import SecurityCriteria
+
+from py_yfinance.source import YFinanceDataSource
+
+
+def test_portseido_xml(xml_path):
+    print(f"Parsing {xml_path}...")
+    try:
+        tree = ET.parse(xml_path)
+        root = tree.getroot()
+    except Exception as e:
+        print(f"Failed to parse XML: {e}")
+        return
+
+    source = YFinanceDataSource()
+
+    trades = root.findall(".//Trade")
+    print(f"Found {len(trades)} trades.")
+
+    unique_resolutions = {}
+
+    for trade in trades:
+        symbol = trade.get("symbol")
+        isin = trade.get("isin")
+        exchange = trade.get("exchange")
+        description = trade.get("description")
+        listing_exchange = trade.get("listingExchange")
+
+        # Create a key for unique check
+        key = (symbol, isin, exchange)
+        if key in unique_resolutions:
+            continue
+
+        print(
+            f"Resolving: Symbol={symbol}, ISIN={isin}, "
+            f"Exch={exchange}, ListingExch={listing_exchange}"
+        )
+
+        # Prepare preferred exchanges
+        preferred = []
+        if exchange:
+            preferred.append(exchange)
+        if listing_exchange and listing_exchange != exchange:
+            preferred.append(listing_exchange)
+
+        criteria = SecurityCriteria(
+            isin=isin, symbol=symbol, description=description, preferred_exchanges=preferred
+        )
+
+        resolved = source.resolve(criteria)
+        unique_resolutions[key] = resolved
+
+        if resolved:
+            print(f"  -> FOUND: {resolved.ticker} ({resolved.name})")
+        else:
+            print("  -> NOT FOUND")
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("Usage: python test_portseido.py <path_to_xml>")
+        sys.exit(1)
+
+    test_portseido_xml(sys.argv[1])

py_yfinance-0.1.0/py_yfinance/__init__.py

@@ -0,0 +1,3 @@
+from .source import YFinanceDataSource
+
+__all__ = ["YFinanceDataSource"]

py_yfinance-0.1.0/py_yfinance/cli.py

@@ -0,0 +1,71 @@
+import sys
+
+try:
+    import typer
+except ImportError:
+    print("Typer not installed. Please install with 'cli' extra: uv sync --extra cli")
+    sys.exit(1)
+
+from typing import List, Optional
+
+from pydantic_market_data.models import SecurityCriteria
+
+from py_yfinance.source import YFinanceDataSource
+
+app = typer.Typer(help="py-yfinance CLI")
+source = YFinanceDataSource()
+
+
+@app.command()
+def lookup(
+    symbol: Optional[str] = typer.Option(None, help="Symbol to search for"),
+    isin: Optional[str] = typer.Option(None, help="ISIN to search for"),
+    exchange: Optional[List[str]] = typer.Option(None, help="Preferred exchanges"),
+    price: Optional[float] = typer.Option(None, help="Target price for validation"),
+    date: Optional[str] = typer.Option(
+        None, help="Target date for validation (YYYY-MM-DD or similar)"
+    ),
+):
+    """
+    Lookup a security by Symbol or ISIN.
+    """
+    criteria = SecurityCriteria(
+        isin=isin, symbol=symbol, preferred_exchanges=exchange, target_price=price, target_date=date
+    )
+
+    result = source.resolve(criteria)
+
+    if result:
+        print(f"Ticker: {result.ticker}")
+        print(f"Name: {result.name}")
+        print(f"Exchange: {result.exchange}")
+        print(f"Currency: {result.currency}")
+    else:
+        print("Not found.")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def history(
+    ticker: str = typer.Argument(..., help="Ticker symbol"),
+    period: str = typer.Option("1mo", help="Period (e.g. 1d, 5d, 1mo, 1y)"),
+):
+    """
+    Get historical data for a ticker.
+    """
+    try:
+        hist = source.history(ticker, period=period)
+        print(f"Symbol: {hist.symbol.ticker}")
+        print(f"Candles: {len(hist.candles)}")
+
+        if hist.candles:
+            last = hist.candles[-1]
+            print(f"Last Candle ({last.date}): Close=${last.close}")
+
+    except Exception as e:
+        print(f"Error: {e}")
+        raise typer.Exit(code=1)
+
+
+if __name__ == "__main__":
+    app()