feat: add Ruff linting workflow and update dependencies for improved code quality

Author: milsman2

.github/workflows/pylint.yaml .github/workflows/ruff.yaml.github/workflows/pylint.yaml renamed to .github/workflows/ruff.yaml

@@ -1,12 +1,12 @@
-name: UV Build - Pylint Lint
+name: UV Build - Ruff Lint
 
 on:
   pull_request:
     branches:
       - '*'
 
 jobs:
-  pylint-lint:
+  ruff-lint:
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -40,10 +40,10 @@ jobs:
       - name: Install dependencies
         run: uv sync
 
-      - name: Run pylint
+      - name: Run Ruff
         run: |
-          uv run -- pylint src
-          uv run -- pylint tests
+          uv run ruff check src
+          uv run ruff check tests
 
       - name: Save uv caches
         if: steps.cache-restore.outputs.cache-hit != 'true'

data/weather/sample.json data/weather/astronomical_sample.jsondata/weather/sample.json renamed to data/weather/astronomical_sample.json

@@ -15,10 +15,10 @@ dependencies = [
     "pydantic-extra-types>=2.11.0",
     "pydantic-settings>=2.12.0",
     "pyfiglet>=1.0.4",
-    "pylint>=4.0.4",
     "pylint-pydantic>=0.4.1",
     "pytest>=9.0.2",
     "rich>=14.3.2",
+    "ruff>=0.15.1",
 ]
 
 [project.optional-dependencies]
@@ -45,3 +45,14 @@ source = ["src"]
 
 [tool.coverage.report]
 omit = ["tests/*"]
+
+[tool.ruff]
+line-length = 88
+exclude = ["__pycache__", "build", "dist", ".venv"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "C", "B", "I", "N", "D", "UP", "T", "A"]
+ignore = []
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["F401"]

pyproject.toml

@@ -0,0 +1 @@
+"""Sample Python app package initialization."""

src/sample_python_app/__init__.py

@@ -1,6 +1,4 @@
-"""
-Export core modules for use in other modules.
-"""
+"""Export core modules for use in other modules."""
 
 from sample_python_app.core.config import settings, weather_settings
 from sample_python_app.core.data_loader import fetch_astronomical_data_from_api

src/sample_python_app/core/__init__.py

@@ -1,6 +1,4 @@
-"""
-Main configuration file for the API
-"""
+"""Main configuration file for the API."""
 
 from zoneinfo import ZoneInfo
 
@@ -35,6 +33,7 @@ class Settings(BaseSettings):
 
     @property
     def tz(self) -> ZoneInfo:
+        """Return the configured timezone info."""
         return ZoneInfo(self.TIMEZONE)
 
 

src/sample_python_app/core/config.py

@@ -1,6 +1,4 @@
-"""
-Handles loading and validating weather.gov astronomical data from file.
-"""
+"""Handles loading and validating weather.gov astronomical data from file."""
 
 import httpx
 from pydantic import ValidationError
@@ -10,6 +8,20 @@
 
 
 def fetch_astronomical_data_from_api(lat: float, lon: float):
+    """Fetch and validate astronomical data from weather.gov API for given coordinates.
+
+    Args:
+        lat (float): Latitude of the location.
+        lon (float): Longitude of the location.
+
+    Returns:
+        AstronomicalData: Validated astronomical data from API response.
+
+    Raises:
+        ValidationError: If the API response fails validation.
+        httpx.HTTPError: If the API request fails.
+
+    """
     logger = setup_logger(mode="silent")
     url = f"https://api.weather.gov/points/{lat},{lon}"
     headers = {"User-Agent": "(myweatherapp.com, contact@myweatherapp.com)"}

src/sample_python_app/core/data_loader.py

@@ -1,6 +1,4 @@
-"""
-Handles formatting and displaying astronomical data using rich and pyfiglet.
-"""
+"""Handles formatting and displaying astronomical data using rich and pyfiglet."""
 
 from pyfiglet import Figlet
 from rich.console import Console
@@ -10,6 +8,15 @@
 
 
 def display_astronomical_data(astro):
+    """Format and display astronomical data using rich and pyfiglet.
+
+    Args:
+        astro: AstronomicalData object containing sunrise, sunset, and formatted values.
+
+    Returns:
+        None
+
+    """
     logger = setup_logger(mode="silent")
     console = Console()
     header = Figlet(font="small", width=100).renderText("Astronomical Data")

src/sample_python_app/core/display.py

@@ -1,6 +1,6 @@
-"""
-Loguru logger configuration for python-app-template.
-"""
+"""Loguru logger configuration for python-app-template."""
+
+import sys
 
 from loguru import logger
 
@@ -13,8 +13,22 @@
 
 
 def setup_logger(mode="normal"):
+    """Configure and return a Loguru logger instance.
+
+    Args:
+        mode (str, optional): Logging mode. "normal" for console and file logging,
+            "silent" for file logging only. Defaults to "normal".
+
+    Returns:
+        logger: Configured Loguru logger instance.
+
+    """
     logger.remove()
     if mode == "silent":
+        # Log errors to the console even in silent mode
+        logger.add(
+            sink=lambda msg: sys.stdout.write(msg), format=log_format, level="ERROR"
+        )
         logger.add(
             "app.log",
             format=log_format,
@@ -24,7 +38,9 @@ def setup_logger(mode="normal"):
             compression="zip",
         )
     else:
-        logger.add(sink=lambda msg: print(msg, end=""), format=log_format, level="INFO")
+        logger.add(
+            sink=lambda msg: sys.stdout.write(msg), format=log_format, level="INFO"
+        )
         logger.add(
             "app.log",
             format=log_format,

src/sample_python_app/core/logging.py

@@ -0,0 +1,7 @@
+"""Custom exceptions package for sample_python_app."""
+
+from sample_python_app.exceptions.custom import (
+    AppError,
+)
+
+__all__ = ["AppError"]