kadeconsole 0.1.0__tar.gz

kadeconsole-0.1.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: kadeconsole
+Version: 0.1.0
+Summary: Bloomberg-terminal-style equity research console powered by yfinance and Jev AI
+Author: kadeConsole Contributors
+License: MIT
+Project-URL: Homepage, https://github.com/kade-console/kade-console
+Project-URL: Repository, https://github.com/kade-console/kade-console
+Project-URL: Issues, https://github.com/kade-console/kade-console/issues
+Project-URL: Changelog, https://github.com/kade-console/kade-console/blob/main/CHANGELOG.md
+Keywords: finance,terminal,equities,bloomberg,yfinance,ai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: yfinance>=0.2.40
+Requires-Dist: rich>=13.7.0
+Requires-Dist: prompt_toolkit>=3.0.43
+Requires-Dist: plotext>=5.2.8
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
+Provides-Extra: jev
+Requires-Dist: typesafe-sdk>=0.1.0; extra == "jev"
+Provides-Extra: alpaca
+Requires-Dist: alpaca-trade-api>=3.0.0; extra == "alpaca"
+Provides-Extra: alphavantage
+Requires-Dist: alpha-vantage>=2.3.1; extra == "alphavantage"
+
+# kadeConsole
+
+> A Bloomberg-terminal-style equity research console — free, open-source, and AI-powered.
+
+```
+  ██╗  ██╗ █████╗ ██████╗ ███████╗
+  ██║ ██╔╝██╔══██╗██╔══██╗██╔════╝
+  █████╔╝ ███████║██║  ██║█████╗
+  ██╔═██╗ ██╔══██║██║  ██║██╔══╝
+  ██║  ██╗██║  ██║██████╔╝███████╗
+  ╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝ ╚══════╝  CONSOLE  v0.1.0
+```
+
+Bloomberg terminals cost ~$24k/year. kadeConsole is free. It gives you the muscle-memory command grammar of a real terminal, dense richly-formatted output, and **Jev** (TypeSafe AI) embedded in every screen — delivering the one non-obvious insight that raw numbers alone can't.
+
+---
+
+## Install
+
+```bash
+pip install kadeconsole
+```
+
+Then launch the REPL:
+
+```bash
+kadeconsole
+```
+
+---
+
+## Quickstart
+
+```
+kadeConsole > AAPL EQUITY          # resolve Apple, set session
+kadeConsole > DES                  # company description
+kadeConsole > FA                   # full fundamentals
+kadeConsole > FA Q                 # quarterly fundamentals
+kadeConsole > GP                   # 1Y price chart
+kadeConsole > GP 6M                # 6-month chart
+kadeConsole > HP                   # historical OHLCV
+kadeConsole > VERDICT              # Jev buy/sell/hold distribution
+kadeConsole > RATE                 # Jev multi-axis fundamental rating
+kadeConsole > HELP                 # full command reference
+kadeConsole > EXIT                 # quit
+```
+
+**Indian markets:**
+```
+kadeConsole > RELIANCE IN NS EQUITY    # Reliance Industries on NSE
+kadeConsole > INFY BO EQUITY           # Infosys on BSE
+```
+
+---
+
+## Command Reference
+
+| Command | Description |
+|---|---|
+| `<TICKER> [EXCHANGE] EQUITY` | Resolve security, set session, show snapshot |
+| `DES` | Company description, sector, key people |
+| `FA` / `FA Q` | Full fundamentals (annual / quarterly) |
+| `GP [timeframe]` | In-terminal price chart (`1D 5D 1M 3M 6M 1Y 2Y 5Y`) |
+| `HP` | Historical OHLCV table |
+| `VERDICT` | Jev buy/sell/hold probability distribution |
+| `RATE` | Jev multi-axis rating (valuation/growth/quality/momentum) |
+| `HELP` / `?` | Command reference |
+| `EXIT` / `QUIT` | Exit the REPL |
+
+*(Phase 2: TA, NI, COMPARE, SOURCE — Phase 3: SCREEN, MACRO, WATCH, EXPORT)*
+
+---
+
+## Configuration
+
+On first run, kadeConsole creates `~/.kadeconsole/config.yaml`:
+
+```yaml
+provider_priority:
+  - yfinance
+
+typesafe_api_key: ""        # Get yours at https://typesafe.ai
+alpaca_api_key: ""
+alphavantage_api_key: ""
+
+default_timeframe: 1Y
+theme: default
+```
+
+Set `typesafe_api_key` to enable **Jev** AI analysis (VERDICT, RATE, anomaly flags). The terminal is fully functional without it — Jev sections show a graceful "unavailable" notice.
+
+---
+
+## Provider Plugins
+
+The `providers/base.py` `DataProvider` interface is public. To add a new source:
+
+1. Subclass `DataProvider`
+2. Implement `get_info()`, `get_price_history()`, `get_financials()`, `get_news()`, `get_peers()`
+3. Register in `~/.kadeconsole/config.yaml` under `provider_priority`
+
+---
+
+## Requirements
+
+- Python 3.10+
+- A modern terminal: **iTerm2** (macOS), **Windows Terminal** (Windows), **GNOME Terminal** / **Kitty** (Linux)
+- *Optional:* TypeSafe AI key for Jev features
+
+---
+
+## Roadmap
+
+- **v0.1 (MVP):** EQUITY, DES, FA, GP, HP, VERDICT, RATE
+- **v0.2:** TA (technical panel), NI (news + sentiment), COMPARE, multi-provider
+- **v0.3:** SCREEN (NL filtering), MACRO, WATCH, EXPORT
+- **v0.4:** Full Textual TUI, tabbed panels, community plugins
+
+---
+
+## License
+
+MIT — use freely, contribute openly.

kadeconsole-0.1.0/README.md

@@ -0,0 +1,123 @@
+# kadeConsole
+
+> A Bloomberg-terminal-style equity research console — free, open-source, and AI-powered.
+
+```
+  ██╗  ██╗ █████╗ ██████╗ ███████╗
+  ██║ ██╔╝██╔══██╗██╔══██╗██╔════╝
+  █████╔╝ ███████║██║  ██║█████╗
+  ██╔═██╗ ██╔══██║██║  ██║██╔══╝
+  ██║  ██╗██║  ██║██████╔╝███████╗
+  ╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝ ╚══════╝  CONSOLE  v0.1.0
+```
+
+Bloomberg terminals cost ~$24k/year. kadeConsole is free. It gives you the muscle-memory command grammar of a real terminal, dense richly-formatted output, and **Jev** (TypeSafe AI) embedded in every screen — delivering the one non-obvious insight that raw numbers alone can't.
+
+---
+
+## Install
+
+```bash
+pip install kadeconsole
+```
+
+Then launch the REPL:
+
+```bash
+kadeconsole
+```
+
+---
+
+## Quickstart
+
+```
+kadeConsole > AAPL EQUITY          # resolve Apple, set session
+kadeConsole > DES                  # company description
+kadeConsole > FA                   # full fundamentals
+kadeConsole > FA Q                 # quarterly fundamentals
+kadeConsole > GP                   # 1Y price chart
+kadeConsole > GP 6M                # 6-month chart
+kadeConsole > HP                   # historical OHLCV
+kadeConsole > VERDICT              # Jev buy/sell/hold distribution
+kadeConsole > RATE                 # Jev multi-axis fundamental rating
+kadeConsole > HELP                 # full command reference
+kadeConsole > EXIT                 # quit
+```
+
+**Indian markets:**
+```
+kadeConsole > RELIANCE IN NS EQUITY    # Reliance Industries on NSE
+kadeConsole > INFY BO EQUITY           # Infosys on BSE
+```
+
+---
+
+## Command Reference
+
+| Command | Description |
+|---|---|
+| `<TICKER> [EXCHANGE] EQUITY` | Resolve security, set session, show snapshot |
+| `DES` | Company description, sector, key people |
+| `FA` / `FA Q` | Full fundamentals (annual / quarterly) |
+| `GP [timeframe]` | In-terminal price chart (`1D 5D 1M 3M 6M 1Y 2Y 5Y`) |
+| `HP` | Historical OHLCV table |
+| `VERDICT` | Jev buy/sell/hold probability distribution |
+| `RATE` | Jev multi-axis rating (valuation/growth/quality/momentum) |
+| `HELP` / `?` | Command reference |
+| `EXIT` / `QUIT` | Exit the REPL |
+
+*(Phase 2: TA, NI, COMPARE, SOURCE — Phase 3: SCREEN, MACRO, WATCH, EXPORT)*
+
+---
+
+## Configuration
+
+On first run, kadeConsole creates `~/.kadeconsole/config.yaml`:
+
+```yaml
+provider_priority:
+  - yfinance
+
+typesafe_api_key: ""        # Get yours at https://typesafe.ai
+alpaca_api_key: ""
+alphavantage_api_key: ""
+
+default_timeframe: 1Y
+theme: default
+```
+
+Set `typesafe_api_key` to enable **Jev** AI analysis (VERDICT, RATE, anomaly flags). The terminal is fully functional without it — Jev sections show a graceful "unavailable" notice.
+
+---
+
+## Provider Plugins
+
+The `providers/base.py` `DataProvider` interface is public. To add a new source:
+
+1. Subclass `DataProvider`
+2. Implement `get_info()`, `get_price_history()`, `get_financials()`, `get_news()`, `get_peers()`
+3. Register in `~/.kadeconsole/config.yaml` under `provider_priority`
+
+---
+
+## Requirements
+
+- Python 3.10+
+- A modern terminal: **iTerm2** (macOS), **Windows Terminal** (Windows), **GNOME Terminal** / **Kitty** (Linux)
+- *Optional:* TypeSafe AI key for Jev features
+
+---
+
+## Roadmap
+
+- **v0.1 (MVP):** EQUITY, DES, FA, GP, HP, VERDICT, RATE
+- **v0.2:** TA (technical panel), NI (news + sentiment), COMPARE, multi-provider
+- **v0.3:** SCREEN (NL filtering), MACRO, WATCH, EXPORT
+- **v0.4:** Full Textual TUI, tabbed panels, community plugins
+
+---
+
+## License
+
+MIT — use freely, contribute openly.

kadeconsole-0.1.0/kadeconsole/__init__.py

@@ -0,0 +1,10 @@
+"""
+kadeConsole — Bloomberg-terminal-style equity research console.
+
+Usage:
+    pip install kadeconsole
+    kadeconsole
+"""
+
+__version__ = "0.1.0"
+__author__ = "kadeConsole Contributors"

kadeconsole-0.1.0/kadeconsole/cache/store.py

@@ -0,0 +1,155 @@
+"""
+cache/store.py — SQLite-backed response and Jev-verdict cache.
+
+Two tables:
+  provider_cache  — raw market data, keyed by (symbol, endpoint), TTL 15 min
+  jev_cache       — Jev responses, keyed by sha256 of (ticker+timeframe+data_hash), TTL 24h
+
+The cache lives at ~/.kadeconsole/cache.db and is created automatically.
+"""
+
+from __future__ import annotations
+
+import hashlib
+import json
+import sqlite3
+import time
+from pathlib import Path
+from typing import Any, Optional
+
+CACHE_DB = Path.home() / ".kadeconsole" / "cache.db"
+
+_CREATE_PROVIDER = """
+CREATE TABLE IF NOT EXISTS provider_cache (
+    key        TEXT PRIMARY KEY,
+    data_json  TEXT NOT NULL,
+    expires_at REAL NOT NULL
+);
+"""
+
+_CREATE_JEV = """
+CREATE TABLE IF NOT EXISTS jev_cache (
+    key          TEXT PRIMARY KEY,
+    response_json TEXT NOT NULL,
+    created_at   REAL NOT NULL,
+    expires_at   REAL NOT NULL
+);
+"""
+
+
+class CacheStore:
+    """Thread-safe SQLite cache store."""
+
+    def __init__(
+        self,
+        db_path: Path = CACHE_DB,
+        provider_ttl_minutes: int = 15,
+        jev_ttl_hours: int = 24,
+    ) -> None:
+        self.db_path = db_path
+        self.provider_ttl = provider_ttl_minutes * 60
+        self.jev_ttl = jev_ttl_hours * 3600
+        self._ensure_db()
+
+    # ── Public API ─────────────────────────────────────────────────────────────
+
+    def get_provider(self, symbol: str, endpoint: str) -> Optional[Any]:
+        """Return cached provider data or None if missing/expired."""
+        key = self._provider_key(symbol, endpoint)
+        row = self._fetch("provider_cache", key)
+        return json.loads(row) if row else None
+
+    def set_provider(self, symbol: str, endpoint: str, data: Any) -> None:
+        """Cache provider data with TTL."""
+        key = self._provider_key(symbol, endpoint)
+        self._upsert("provider_cache", key, json.dumps(data, default=str), self.provider_ttl)
+
+    def get_jev(self, ticker: str, timeframe: str, data_fingerprint: str) -> Optional[Any]:
+        """Return cached Jev response or None if missing/expired."""
+        key = self._jev_key(ticker, timeframe, data_fingerprint)
+        row = self._fetch_jev(key)
+        return json.loads(row) if row else None
+
+    def set_jev(self, ticker: str, timeframe: str, data_fingerprint: str, response: Any) -> None:
+        """Cache a Jev response with TTL."""
+        key = self._jev_key(ticker, timeframe, data_fingerprint)
+        self._upsert("jev_cache", key, json.dumps(response, default=str), self.jev_ttl)
+
+    def clear_expired(self) -> None:
+        """Purge all expired rows from both tables."""
+        now = time.time()
+        with self._connect() as conn:
+            conn.execute("DELETE FROM provider_cache WHERE expires_at < ?", (now,))
+            conn.execute("DELETE FROM jev_cache WHERE expires_at < ?", (now,))
+
+    def clear_all(self) -> None:
+        """Nuke entire cache (useful for debugging)."""
+        with self._connect() as conn:
+            conn.execute("DELETE FROM provider_cache")
+            conn.execute("DELETE FROM jev_cache")
+
+    # ── Helpers ────────────────────────────────────────────────────────────────
+
+    @staticmethod
+    def make_data_fingerprint(data: Any) -> str:
+        """Return a short sha256 fingerprint of any JSON-serialisable data."""
+        raw = json.dumps(data, sort_keys=True, default=str).encode()
+        return hashlib.sha256(raw).hexdigest()[:16]
+
+    # ── Internal ───────────────────────────────────────────────────────────────
+
+    def _ensure_db(self) -> None:
+        self.db_path.parent.mkdir(parents=True, exist_ok=True)
+        with self._connect() as conn:
+            conn.execute(_CREATE_PROVIDER)
+            conn.execute(_CREATE_JEV)
+
+    def _connect(self) -> sqlite3.Connection:
+        return sqlite3.connect(str(self.db_path))
+
+    def _fetch(self, table: str, key: str) -> Optional[str]:
+        """Fetch from provider_cache (data_json column)."""
+        now = time.time()
+        with self._connect() as conn:
+            row = conn.execute(
+                f"SELECT data_json FROM {table} WHERE key=? AND expires_at>?",
+                (key, now),
+            ).fetchone()
+        return row[0] if row else None
+
+    def _fetch_jev(self, key: str) -> Optional[str]:
+        """Fetch from jev_cache (response_json column)."""
+        now = time.time()
+        with self._connect() as conn:
+            row = conn.execute(
+                "SELECT response_json FROM jev_cache WHERE key=? AND expires_at>?",
+                (key, now),
+            ).fetchone()
+        return row[0] if row else None
+
+    def _upsert(self, table: str, key: str, data_json: str, ttl: float) -> None:
+        now = time.time()
+        expires = now + ttl
+        if table == "provider_cache":
+            sql = (
+                "INSERT OR REPLACE INTO provider_cache (key, data_json, expires_at) "
+                "VALUES (?, ?, ?)"
+            )
+            with self._connect() as conn:
+                conn.execute(sql, (key, data_json, expires))
+        else:
+            sql = (
+                "INSERT OR REPLACE INTO jev_cache (key, response_json, created_at, expires_at) "
+                "VALUES (?, ?, ?, ?)"
+            )
+            with self._connect() as conn:
+                conn.execute(sql, (key, data_json, now, expires))
+
+    @staticmethod
+    def _provider_key(symbol: str, endpoint: str) -> str:
+        return f"{symbol.upper()}:{endpoint}"
+
+    @staticmethod
+    def _jev_key(ticker: str, timeframe: str, fingerprint: str) -> str:
+        raw = f"{ticker.upper()}:{timeframe}:{fingerprint}"
+        return hashlib.sha256(raw.encode()).hexdigest()

kadeconsole-0.1.0/kadeconsole/cli.py

@@ -0,0 +1,193 @@
+"""
+cli.py — kadeConsole REPL entrypoint.
+
+Entry point: `kadeconsole` (via pyproject.toml console_scripts)
+
+Startup sequence:
+  1. Load config from ~/.kadeconsole/config.yaml
+  2. Initialise provider registry + Jev client + SQLite cache
+  3. Print startup banner
+  4. Drop into prompt_toolkit REPL loop
+  5. Parse each input line → Router.dispatch() → continue or exit
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import Optional
+
+from rich.console import Console
+
+from kadeconsole.render.theme import RICH_THEME, t
+from kadeconsole import __version__
+
+console = Console(theme=RICH_THEME)
+
+# ── Banner ─────────────────────────────────────────────────────────────────────
+_BANNER = r"""
+  ██╗  ██╗ █████╗ ██████╗ ███████╗
+  ██║ ██╔╝██╔══██╗██╔══██╗██╔════╝
+  █████╔╝ ███████║██║  ██║█████╗
+  ██╔═██╗ ██╔══██║██║  ██║██╔══╝
+  ██║  ██╗██║  ██║██████╔╝███████╗
+  ╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝ ╚══════╝
+"""
+
+
+def _print_banner() -> None:
+    console.print(f"[accent]{_BANNER}[/accent]", highlight=False)
+    console.print(
+        f"  [bold {t.accent}]CONSOLE[/bold {t.accent}]  "
+        f"[{t.muted}]v{__version__}[/]  "
+        f"[{t.dim_text}]·  Bloomberg-style equity research terminal[/]\n"
+    )
+    console.print(
+        f"  [{t.muted}]Type [accent]HELP[/accent] or [accent]?[/accent] for the command reference.  "
+        f"[accent]EXIT[/accent] or [accent]Q[/accent] to quit.[/]\n"
+    )
+
+
+# ── Autocomplete word list ─────────────────────────────────────────────────────
+_AUTOCOMPLETE_WORDS = [
+    "EQUITY", "DES", "FA", "FA Q", "GP", "HP", "VERDICT", "RATE",
+    "TA", "NI", "RV", "COMPARE", "MACRO", "SCREEN", "WATCH", "EXPORT",
+    "SOURCE", "HELP", "EXIT", "QUIT",
+    "1D", "5D", "1M", "3M", "6M", "1Y", "2Y", "5Y",
+]
+
+
+def _build_completer():
+    """Build a prompt_toolkit WordCompleter for the REPL."""
+    try:
+        from prompt_toolkit.completion import WordCompleter
+        return WordCompleter(_AUTOCOMPLETE_WORDS, ignore_case=True, sentence=True)
+    except ImportError:
+        return None
+
+
+def _build_prompt_session():
+    """Build a prompt_toolkit PromptSession (with history)."""
+    try:
+        from prompt_toolkit import PromptSession
+        from prompt_toolkit.history import FileHistory
+        from prompt_toolkit.auto_suggest import AutoSuggestFromHistory
+        from pathlib import Path
+
+        hist_file = Path.home() / ".kadeconsole" / "history"
+        hist_file.parent.mkdir(parents=True, exist_ok=True)
+
+        return PromptSession(
+            history=AutoSuggestFromHistory() and FileHistory(str(hist_file)),
+            auto_suggest=AutoSuggestFromHistory(),
+            completer=_build_completer(),
+            complete_while_typing=False,
+        )
+    except ImportError:
+        return None
+
+
+def _simple_input(prompt: str) -> str:
+    """Fallback to built-in input() when prompt_toolkit is unavailable."""
+    try:
+        return input(prompt)
+    except EOFError:
+        return "EXIT"
+
+
+def main() -> None:
+    """Main entrypoint — called by the `kadeconsole` console script."""
+
+    # ── 1. Load config ─────────────────────────────────────────────────────────
+    from kadeconsole.config.loader import load_config
+    config = load_config()
+
+    # ── 2. Initialise cache ────────────────────────────────────────────────────
+    from kadeconsole.cache.store import CacheStore
+    cache = CacheStore(
+        provider_ttl_minutes = config.get("cache_ttl_provider_minutes", 15),
+        jev_ttl_hours        = config.get("cache_ttl_jev_hours", 24),
+    )
+    cache.clear_expired()  # housekeeping on startup
+
+    # ── 3. Initialise providers ────────────────────────────────────────────────
+    from kadeconsole.providers.registry import ProviderRegistry
+    registry = ProviderRegistry(config)
+    provider = registry.get_primary()
+
+    # ── 4. Initialise Jev client ───────────────────────────────────────────────
+    from kadeconsole.jev.client import JevClient
+    jev = JevClient(
+        api_key = config.get("typesafe_api_key", ""),
+        cache   = cache,
+    )
+
+    # ── 5. Session + Router ───────────────────────────────────────────────────
+    from kadeconsole.core.session import Session
+    from kadeconsole.core.router import Router
+    session = Session(timeframe=config.get("default_timeframe", "1Y"))
+    router  = Router(session=session, provider=provider, jev=jev)
+
+    # ── 6. Banner ──────────────────────────────────────────────────────────────
+    _print_banner()
+
+    # Provider status line
+    provider_line = f"[{t.muted}]  Data: [accent]{provider.name}[/accent]"
+    if registry.provider_names:
+        provider_line += f"  [{t.muted}]({', '.join(registry.provider_names)})[/]"
+    jev_status = (
+        f"[positive]◆ Jev active[/positive]"
+        if jev.available
+        else f"[{t.muted}]◆ Jev inactive — set TYPESAFE_API_KEY to enable AI analysis[/]"
+    )
+    console.print(f"{provider_line}   {jev_status}\n")
+
+    # ── 7. REPL loop ───────────────────────────────────────────────────────────
+    prompt_session = _build_prompt_session()
+
+    # Prompt style — amber "kadeConsole >" prefix
+    prompt_str = f"kadeConsole > "
+
+    while True:
+        try:
+            if prompt_session is not None:
+                try:
+                    from prompt_toolkit.styles import Style as PTStyle
+                    pt_style = PTStyle.from_dict({
+                        "": f"#{t.text[1:]}",
+                        "prompt": f"bold #{t.accent[1:]}",
+                    })
+                    raw = prompt_session.prompt(
+                        [("class:prompt", prompt_str)],
+                        style=pt_style,
+                    )
+                except Exception:
+                    raw = prompt_session.prompt(prompt_str)
+            else:
+                raw = _simple_input(prompt_str)
+
+        except KeyboardInterrupt:
+            console.print(f"\n[{t.muted}]  Use EXIT or Q to quit.[/]\n")
+            continue
+        except EOFError:
+            break
+
+        raw = raw.strip()
+        if not raw:
+            continue
+
+        # Parse and dispatch
+        from kadeconsole.core.parser import parse, ParseError
+        try:
+            parsed = parse(raw)
+        except ParseError as exc:
+            console.print(f"[negative]  Parse error: {exc}[/negative]")
+            continue
+
+        keep_going = router.dispatch(parsed)
+        if not keep_going:
+            console.print(f"\n[{t.muted}]  Goodbye.[/]\n")
+            break
+
+
+if __name__ == "__main__":
+    main()