grynn-fplot 0.3.1__tar.gz → 0.3.2__tar.gz

{grynn_fplot-0.3.1 → grynn_fplot-0.3.2}/.github/workflows/publish.yml

@@ -7,15 +7,6 @@ on:
   release:
     types: [published]
   workflow_dispatch:
-    inputs:
-      target:
-        description: 'Publish target'
-        required: true
-        default: 'testpypi'
-        type: choice
-        options:
-          - testpypi
-          - pypi
 
 jobs:
   build:
@@ -44,28 +35,6 @@ jobs:
           name: python-package-distributions
           path: dist/
 
-  publish-testpypi:
-    name: Publish to TestPyPI
-    if: github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'testpypi'
-    needs: build
-    runs-on: ubuntu-latest
-    environment:
-      name: testpypi
-      url: https://test.pypi.org/p/grynn-fplot
-    permissions:
-      id-token: write
-    steps:
-      - name: Download distributions
-        uses: actions/download-artifact@v4
-        with:
-          name: python-package-distributions
-          path: dist/
-
-      - name: Publish to TestPyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          repository-url: https://test.pypi.org/legacy/
-
   publish-pypi:
     name: Publish to PyPI
     if: github.event_name == 'push' || github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'pypi')

{grynn_fplot-0.3.1 → grynn_fplot-0.3.2}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: grynn-fplot
-Version: 0.3.1
+Version: 0.3.2
 Summary: CLI tool for plotting financial data and analyzing options
-Project-URL: Homepage, https://github.com/Grynn/grynn_fplot
-Project-URL: Repository, https://github.com/Grynn/grynn_fplot
-Project-URL: Issues, https://github.com/Grynn/grynn_fplot/issues
+Project-URL: Homepage, https://github.com/Grynn/grynn_cli_fplot
+Project-URL: Issues, https://github.com/Grynn/grynn_cli_fplot/issues
+Project-URL: Repository, https://github.com/Grynn/grynn_cli_fplot
 Author-email: Grynn <vishal.doshi@gmail.com>
 License: MIT
 Keywords: cli,finance,options,plotting,stocks

{grynn_fplot-0.3.1 → grynn_fplot-0.3.2}/grynn_fplot/cli.py

@@ -52,6 +52,7 @@ except importlib.metadata.PackageNotFoundError:
     default=None,
     help="Filter expression (e.g., 'dte>300', 'dte>10, dte<15', 'dte>300 + strike<100')",
 )
+@click.option("--filter-help", is_flag=True, help="Show help for filter expressions and exit")
 @click.option("--web", "-w", is_flag=True, help="Launch interactive web interface")
 @click.option("--port", type=int, default=8000, help="Port for web interface")
 @click.option("--host", type=str, default="127.0.0.1", help="Host for web interface")
@@ -68,6 +69,7 @@ def display_plot(
     min_dte,
     show_all,
     filter_expr,
+    filter_help,
     web,
     port,
     host,
@@ -107,6 +109,13 @@ def display_plot(
         print(f"fplot {__version__}")
         return
 
+    # Show filter help if requested
+    if filter_help:
+        from grynn_fplot.filter_parser import get_filter_help
+
+        print(get_filter_help())
+        return
+
     # Launch web interface if --web flag is used
     if web:
         launch_web_interface(ticker, since, interval, port, host, no_browser, debug)

{grynn_fplot-0.3.1 → grynn_fplot-0.3.2}/grynn_fplot/core.py

@@ -486,19 +486,25 @@ def format_options_for_display(
             strike = option.get("strike", 0)
             volume = option.get("volume", 0) or 0  # Handle None values
             last_price = option.get("lastPrice", 0) or 0
-            
+
             # Get last trade date and calculate days since last trade
             last_trade_date = option.get("lastTradeDate", None)
             lt_days = None
             if last_trade_date:
                 try:
-                    from datetime import datetime
+                    from datetime import datetime, timezone
+
                     # lastTradeDate can be a timestamp or datetime
                     if isinstance(last_trade_date, (int, float)):
                         last_trade_dt = datetime.fromtimestamp(last_trade_date)
                     else:
                         last_trade_dt = last_trade_date
-                    lt_days = (datetime.now() - last_trade_dt).days
+                    # Convert both to timezone-aware UTC for comparison
+                    now_utc = datetime.now(timezone.utc)
+                    if last_trade_dt.tzinfo is None:
+                        # If last_trade_dt is naive, assume UTC
+                        last_trade_dt = last_trade_dt.replace(tzinfo=timezone.utc)
+                    lt_days = (now_utc - last_trade_dt).days
                 except Exception:
                     lt_days = None
 

{grynn_fplot-0.3.1 → grynn_fplot-0.3.2}/grynn_fplot/filter_parser.py

@@ -26,6 +26,39 @@ from typing import Any, Dict, List, Union
 from dataclasses import dataclass
 
 
+# Registry of available filter fields with descriptions
+FILTER_FIELDS = {
+    "dte": {"description": "Days to expiry", "type": "integer", "example": "dte>150"},
+    "volume": {"description": "Option trading volume", "type": "integer", "example": "volume>100"},
+    "price": {"description": "Last traded price", "type": "float", "example": "price<5.0"},
+    "return": {
+        "description": "Return metric (CAGR for calls, annualized return for puts)",
+        "type": "float",
+        "aliases": ["ret", "ar"],
+        "example": "return>0.15",
+    },
+    "ret": {"description": "Alias for 'return'", "type": "float", "alias_of": "return", "example": "ret>0.15"},
+    "ar": {
+        "description": "Alias for 'return' (annualized return)",
+        "type": "float",
+        "alias_of": "return",
+        "example": "ar>0.15",
+    },
+    "strike_pct": {
+        "description": "Strike percentage relative to spot price (positive = above spot, negative = below spot)",
+        "type": "float",
+        "aliases": ["sp"],
+        "example": "strike_pct>5",
+    },
+    "sp": {"description": "Alias for 'strike_pct'", "type": "float", "alias_of": "strike_pct", "example": "sp>5"},
+    "lt_days": {
+        "description": "Days since last trade (useful for filtering stale/illiquid options)",
+        "type": "integer",
+        "example": "lt_days<7",
+    },
+}
+
+
 @dataclass
 class FilterNode:
     """Represents a single filter condition"""
@@ -451,3 +484,82 @@ def filter_to_string(filter_dict: Dict[str, Any]) -> str:
         return f"({separator.join(children_strs)})"
     else:
         raise ValueError(f"Invalid filter dictionary: {filter_dict}")
+
+
+def get_filter_help() -> str:
+    """Generate formatted help text for available filter fields.
+
+    Returns:
+        Formatted help text describing all filter fields, operators, and syntax
+    """
+    help_lines = []
+
+    # Header
+    help_lines.append("Filter Expression Reference")
+    help_lines.append("=" * 50)
+    help_lines.append("")
+
+    # Available Fields
+    help_lines.append("Available Filter Fields:")
+    help_lines.append("-" * 50)
+
+    # Group main fields (exclude aliases)
+    main_fields = {k: v for k, v in FILTER_FIELDS.items() if "alias_of" not in v}
+
+    for field_name in sorted(main_fields.keys()):
+        field_info = main_fields[field_name]
+        help_lines.append(f"\n  {field_name}")
+        help_lines.append(f"    {field_info['description']}")
+        help_lines.append(f"    Type: {field_info['type']}")
+
+        # Show aliases if any
+        if "aliases" in field_info:
+            aliases_str = ", ".join(field_info["aliases"])
+            help_lines.append(f"    Aliases: {aliases_str}")
+
+        help_lines.append(f"    Example: {field_info['example']}")
+
+    # Operators
+    help_lines.append("\n")
+    help_lines.append("Comparison Operators:")
+    help_lines.append("-" * 50)
+    help_lines.append("  >   Greater than")
+    help_lines.append("  <   Less than")
+    help_lines.append("  >=  Greater than or equal")
+    help_lines.append("  <=  Less than or equal")
+    help_lines.append("  =   Equal (also ==)")
+    help_lines.append("  !=  Not equal")
+
+    # Logical Operators
+    help_lines.append("\n")
+    help_lines.append("Logical Operators:")
+    help_lines.append("-" * 50)
+    help_lines.append("  ,   AND - all conditions must be true")
+    help_lines.append("  +   OR  - at least one condition must be true")
+    help_lines.append("  ()  Parentheses for grouping")
+
+    # Time Value Formats
+    help_lines.append("\n")
+    help_lines.append("Time Value Formats:")
+    help_lines.append("-" * 50)
+    help_lines.append("  DTE-style (returns days): 1y, 6m, 2w, 30d")
+    help_lines.append("  Duration (returns hours): 2d15h, 30m, 1h")
+    help_lines.append("  Plain integers: 5, 150, 300")
+
+    # Examples
+    help_lines.append("\n")
+    help_lines.append("Example Filters:")
+    help_lines.append("-" * 50)
+    help_lines.append("  dte>150")
+    help_lines.append("    Options with more than 150 days to expiry")
+    help_lines.append("")
+    help_lines.append("  dte>150, lt_days<7")
+    help_lines.append("    Options with DTE > 150 AND traded in last 7 days")
+    help_lines.append("")
+    help_lines.append("  (dte>300 + dte<30), volume>100")
+    help_lines.append("    Options with (DTE > 300 OR DTE < 30) AND volume > 100")
+    help_lines.append("")
+    help_lines.append("  return>0.20, sp>5, sp<15")
+    help_lines.append("    Options with return > 20%, strike 5-15% above spot")
+
+    return "\n".join(help_lines)

grynn_fplot-0.3.2/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[project]
+authors = [{name = "Grynn", email = "vishal.doshi@gmail.com"}]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Financial and Insurance Industry",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Office/Business :: Financial :: Investment",
+]
+dependencies = [
+  "click ~= 8.1.7",
+  "matplotlib >= 3.9.2",
+  "dateparser ~= 1.2.0",
+  "mplcursors ~= 0.5.3",
+  "fastapi ~= 0.115.0",
+  "uvicorn ~= 0.32.0",
+  "scikit-learn >= 1.6.1",
+  "grynn-pylib",
+  "ipywidgets>=8.1.5",
+  "tabulate>=0.9.0",
+  "yfinance",
+  "pandas>=2.2.3",
+]
+description = "CLI tool for plotting financial data and analyzing options"
+keywords = ["finance", "stocks", "options", "plotting", "cli"]
+license = {text = "MIT"}
+name = "grynn-fplot"
+readme = "README.md"
+requires-python = ">=3.12"
+version = "0.3.2"
+
+[project.scripts]
+fplot = "grynn_fplot.cli:display_plot"
+
+[project.urls]
+Homepage = "https://github.com/Grynn/grynn_cli_fplot"
+Issues = "https://github.com/Grynn/grynn_cli_fplot/issues"
+Repository = "https://github.com/Grynn/grynn_cli_fplot"
+
+[project.optional-dependencies]
+dev = [
+  "ipykernel>=6.29.5",
+  "ipython>=8.18.1",
+  "mypy>=1.14.1",
+  "pytest>=8.3.4",
+  "ruff>=0.9.2",
+]
+
+[tool.uv.sources]
+grynn-pylib = {git = "https://github.com/Grynn/grynn_pylib.git"}
+yfinance = {git = "https://github.com/ranaroussi/yfinance.git"}
+
+[dependency-groups]
+dev = [
+  "httpx>=0.28.1",
+  "pre-commit>=4.1.0",
+]
+
+[tool.ruff]
+line-length = 120

{grynn_fplot-0.3.1 → grynn_fplot-0.3.2}/uv.lock

@@ -383,7 +383,7 @@ wheels = [
 
 [[package]]
 name = "grynn-fplot"
-version = "0.3.1"
+version = "0.3.2"
 source = { editable = "." }
 dependencies = [
     { name = "click" },

grynn_fplot-0.3.1/pyproject.toml

@@ -1,66 +0,0 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[project]
-name = "grynn-fplot"
-version = "0.3.1"
-description = "CLI tool for plotting financial data and analyzing options"
-authors = [{ name = "Grynn", email = "vishal.doshi@gmail.com" }]
-requires-python = ">=3.12"
-readme = "README.md"
-license = { text = "MIT" }
-keywords = ["finance", "stocks", "options", "plotting", "cli"]
-classifiers = [
-    "Development Status :: 4 - Beta",
-    "Environment :: Console",
-    "Intended Audience :: Financial and Insurance Industry",
-    "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Topic :: Office/Business :: Financial :: Investment",
-]
-dependencies = [
-    "click ~= 8.1.7",
-    "matplotlib >= 3.9.2",
-    "dateparser ~= 1.2.0",
-    "mplcursors ~= 0.5.3",
-    "fastapi ~= 0.115.0",
-    "uvicorn ~= 0.32.0",
-    "scikit-learn >= 1.6.1",
-    "grynn-pylib",
-    "ipywidgets>=8.1.5",
-    "tabulate>=0.9.0",
-    "yfinance",
-    "pandas>=2.2.3",
-]
-
-[project.scripts]
-fplot = "grynn_fplot.cli:display_plot"
-
-[project.urls]
-Homepage = "https://github.com/Grynn/grynn_fplot"
-Repository = "https://github.com/Grynn/grynn_fplot"
-Issues = "https://github.com/Grynn/grynn_fplot/issues"
-
-[project.optional-dependencies]
-dev = [
-    "ipykernel>=6.29.5",
-    "ipython>=8.18.1",
-    "mypy>=1.14.1",
-    "pytest>=8.3.4",
-    "ruff>=0.9.2",
-]
-
-[tool.uv.sources]
-grynn-pylib = { git = "https://github.com/Grynn/grynn_pylib.git" }
-yfinance = { git = "https://github.com/ranaroussi/yfinance.git" }
-
-[dependency-groups]
-dev = [
-    "httpx>=0.28.1",
-    "pre-commit>=4.1.0",
-]
-
-[tool.ruff]
-line-length = 120