feat: add run_checks script and improve scheduling logic for display

Author: milsman2

pyproject.toml

@@ -32,6 +32,7 @@ build-backend = "uv_build"
 
 [project.scripts]
 sample-python-app = "sample_python_app.main:run_app"
+checks = "sample_python_app.scripts:run_checks"
 
 [tool.semantic_release]
 build_command = """

scripts/checks.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# Run project linting, formatting and tests using `uv` as in this repo.
+set -euo pipefail
+
+# Change to repo root (script placed in scripts/)
+cd "$(dirname "$0")/.."
+
+echo "⚡ Running ruff (auto-fix where possible)"
+uv run ruff check . --fix
+
+echo "⚡ Running isort"
+uv run isort .
+
+echo "⚡ Running black"
+uv run black .
+
+echo "⚡ Re-running ruff to catch any remaining issues"
+uv run ruff check .
+
+echo "⚡ Running tests"
+uv run -- coverage run -m pytest
+
+echo "All checks completed."

src/sample_python_app/app/runner.py

@@ -33,13 +33,11 @@ def __init__(self) -> None:
         self._last_displayed_day: str | None = None
 
     def fetch(self, *, exit_on_error: bool = True) -> None:
-        """Fetch astronomical data and display if it is new day's data."""
+        """Fetch astronomical data and display if not already displayed today."""
         lat = weather_settings.LOCATION.latitude
         lon = weather_settings.LOCATION.longitude
         logger.info(f"Using latitude={lat} longitude={lon}")
-
         start = time.time()
-
         try:
             astro = fetch_astronomical_data_from_api(lat, lon)
             FETCH_COUNTER.inc()
@@ -54,15 +52,16 @@ def fetch(self, *, exit_on_error: bool = True) -> None:
             return
         finally:
             FETCH_DURATION.observe(time.time() - start)
-
-        # Only display once per day
         today_str = date.today().isoformat()
         if self._last_displayed_day != today_str:
             display_astronomical_data(astro)
             self._last_displayed_day = today_str
 
+    def reset_display(self):
+        """Reset the last displayed day so display will occur again."""
+        self._last_displayed_day = None
+
     def _handle_fetch_error(self, exc: Exception, exit_on_error: bool) -> None:
-        """Handle errors during the fetch operation."""
         FETCH_ERRORS.inc()
         if isinstance(exc, httpx.HTTPStatusError):
             logger.error("HTTP status error: %s", exc)
@@ -74,10 +73,8 @@ def _handle_fetch_error(self, exc: Exception, exit_on_error: bool) -> None:
             logger.error("JSON decode error: %s", exc)
         else:
             logger.exception("Unexpected error")
-
         if exit_on_error:
             raise SystemExit(1) from exc
-
         raise AppError(str(exc)) from exc
 
 

src/sample_python_app/app/scheduler.py

@@ -17,6 +17,9 @@ def start_scheduler(test_mode: bool = False) -> None:
     scheduler_logger = logger.bind(component="scheduler")
 
     if test_mode:
+        # Ensure display will run in tests by clearing any previous state
+        if hasattr(fetcher, "reset_display") and callable(fetcher.reset_display):
+            fetcher.reset_display()
         fetcher.fetch(exit_on_error=False)
         return
 

src/sample_python_app/scripts.py

@@ -0,0 +1,37 @@
+"""Utility scripts exposed via pyproject `project.scripts`.
+
+Provides `run_checks()` which runs linters, formatters and tests.
+"""
+
+from __future__ import annotations
+
+import subprocess
+import sys
+from pathlib import Path
+
+from sample_python_app.core.logging import setup_logger
+
+ROOT = Path(__file__).resolve().parents[2]
+
+
+def _run(cmd: list[str]) -> None:
+    logger = setup_logger("normal")
+    logger.info(f"Running: {' '.join(cmd)}")
+    subprocess.check_call(cmd, cwd=str(ROOT))
+
+
+def run_checks() -> None:
+    """Run ruff, isort, black and tests (coverage+pytest).
+
+    This is intended to be invoked via the project script entrypoint, e.g.:
+    `uv run checks` or `python -m sample_python_app.scripts run_checks` when installed.
+    """
+    py = sys.executable
+    _run([py, "-m", "ruff", "check", ".", "--fix", "--exit-zero"])
+    _run([py, "-m", "isort", "."])
+    _run([py, "-m", "black", "."])
+    _run([py, "-m", "ruff", "check", ".", "--exit-zero"])
+    _run([py, "-m", "coverage", "run", "-m", "pytest"])
+
+    logger = setup_logger("normal")
+    logger.info("All checks completed.")

tests/test_main.py

@@ -3,7 +3,7 @@
 import subprocess
 import sys
 
-from sample_python_app.app.runner import fetch_astro_data
+from sample_python_app.app.runner import fetcher
 
 
 def test_main_subprocess():
@@ -25,7 +25,10 @@ def test_main_subprocess():
 def test_main_runs(capfd):
     """Test main run_app output."""
     # Call fetch_astro_data directly to test output
-    fetch_astro_data()
+    # Ensure display will occur during test
+    if hasattr(fetcher, "reset_display"):
+        fetcher.reset_display()
+    fetcher.fetch()
     out, _ = capfd.readouterr()
     assert "Sunrise" in out
     assert "Sunset" in out