Updated CI pipeline + pre-commit

Author: mbrickerd

.github/workflows/python-ci.yml

@@ -3,78 +3,77 @@ name: Python CI
 on:
   push:
     branches: [ main ]
-
   pull_request:
     branches: [ main ]
 
 jobs:
-  lint:
+  quality:
     name: Code Quality
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      
+      - uses: actions/checkout@v4
+
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: latest
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v3
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+      - name: Set up uv cache
+        uses: actions/cache@v4
         with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
-          
+          path: |
+            ~/.cache/uv
+            ~/.uv
+          key: ${{ runner.os }}-uv-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-uv-
+
       - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
+        run: uv pip install -e '.[dependency-groups.dev]'
+
+      - name: Check formatting
+        run: ruff format --check .
 
-      - name: Check imports with isort
-        run: poetry run isort . --check-only --profile black
-          
-      - name: Check formatting with Black
-        run: poetry run black . --check
-          
-      - name: Lint with flake8
-        run: poetry run flake8 .
+      - name: Run linting
+        run: ruff check .
+
+      - name: Run type checking
+        run: mypy .
 
   test:
     name: Tests
-    needs: lint  # This job will only run if lint job passes
+    needs: quality
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      
+      - uses: actions/checkout@v4
+
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: latest
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v3
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+      - name: Set up uv cache
+        uses: actions/cache@v4
         with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
-          
+          path: |
+            ~/.cache/uv
+            ~/.uv
+          key: ${{ runner.os }}-uv-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-uv-
+
       - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
-          
+        run: uv pip install -e '.[dependency-groups.dev]'
+
       - name: Run tests
-        run: poetry run pytest tests/
+        run: pytest tests/

.gitignore

@@ -1,6 +1,9 @@
 # Byte-compiled / optimized / DLL files
 __pycache__/
 .pytest_cache
+.pdm-build
+.mypy_cache
+.ruff_cache
 *.py[cod]
 *$py.class
 
@@ -12,4 +15,5 @@ data/*
 aoc_headers.json
 aoc_session
 
-*.DS_Store
+*.DS_Store
+*uv.lock

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+    -   id: ruff
+        args: [--fix]
+    -   id: ruff-format
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+    -   id: mypy
+        additional_dependencies: [
+            "types-requests>=2.32.0",
+            "types-beautifulsoup4>=4.12.0"
+        ]
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-toml
+    -   id: check-added-large-files

Makefile

@@ -1,36 +1,55 @@
+.PHONY: help install lint lint-fix format check test type-check all setup-pre-commit fix-all
+
 .DEFAULT: help
 
 help:
 	@echo "make install"
-	@echo "       install all dependencies specified in pyproject.toml"
+	@echo "       install all dependencies specified in pyproject.toml using uv"
+	@echo "make setup-pre-commit"
+	@echo "       set up pre-commit hooks"
 	@echo "make lint"
-	@echo "       run flake8 checks"
+	@echo "       run ruff linting checks"
+	@echo "make lint-fix"
+	@echo "       run ruff linting checks and fix auto-fixable issues"
 	@echo "make format"
-	@echo "       run isort and black to format code"
+	@echo "       run ruff format to format code and organize imports"
+	@echo "make type-check"
+	@echo "       run mypy for type checking"
 	@echo "make check"
-	@echo "       run all code quality checks (format + lint)"
+	@echo "       run all code quality checks (format + lint + type-check)"
+	@echo "make fix-all"
+	@echo "       run all auto-fixes (format + lint-fix)"
 	@echo "make test"
 	@echo "       run pytest"
 	@echo "make all"
-	@echo "       run format, lint, and test"
+	@echo "       run format, lint, type-check, and test"
 	@echo "make help"
 	@echo "       print this help message"
 
 install:
-	poetry install
+	uv pip install -e ".[dependency-groups.dev]"
+	$(MAKE) setup-pre-commit
+
+setup-pre-commit:
+	pre-commit install
 
 lint:
-	poetry run flake8 .
+	ruff check .
+
+lint-fix:
+	ruff check --fix .
 
 format:
-	poetry run isort .
-	poetry run black .
+	ruff format .
 
-check: format lint
+type-check:
+	mypy .
 
-test:
-	poetry run pytest tests/
+check: format lint type-check
+
+fix-all: format lint-fix
 
-all: format lint test
+test:
+	pytest tests/
 
-.PHONY: help install lint format check test all
+all: format lint type-check test

README.md

@@ -313,8 +313,3 @@ This will output detailed results, showing which tests passed, failed, or encoun
 ## Acknowledgments
 
 This project structure was inspired by [nitekat1124's Advent of Code 2024 repository](https://github.com/nitekat1124/advent-of-code-2024).
-
-
-
-
-

aoc/models/authenticator.py

@@ -0,0 +1,62 @@
+"""
+Utility for managing Advent of Code authentication credentials.
+
+Provides methods to retrieve project paths and authentication details
+for interacting with the Advent of Code platform.
+"""
+
+import json
+import os
+from pathlib import Path
+import sys
+
+
+class Authenticator:
+    """Utility class for retrieving Advent of Code authentication details."""
+
+    @staticmethod
+    def get_path() -> Path:
+        """
+        Determine the absolute path to the project directory.
+
+        Returns
+        -------
+            Path to the directory containing the current script or script's parent.
+        """
+        path = os.path.realpath(sys.argv[0])
+        return Path(path).parent if not Path(path).is_dir() else Path(path)
+
+    @staticmethod
+    def get_session() -> str:
+        """
+        Retrieve the Advent of Code session token from a local file.
+
+        Returns
+        -------
+            Stripped session token for authentication.
+
+        Raises
+        ------
+            FileNotFoundError: If the session file is missing.
+            IOError: If there are issues reading the session file.
+        """
+        session_path = Authenticator.get_path() / "aoc_session"
+        return session_path.read_text().strip()
+
+    @staticmethod
+    def get_headers() -> dict[str, str]:
+        """
+        Load HTTP headers configuration from a JSON file.
+
+        Returns
+        -------
+            Dictionary of HTTP headers for API requests.
+
+        Raises
+        ------
+            FileNotFoundError: If the headers configuration file is missing.
+            json.JSONDecodeError: If the JSON is malformed.
+        """
+        headers_config_path = Authenticator.get_path() / "aoc_headers.json"
+        headers: dict[str, str] = json.loads(headers_config_path.read_text().strip())
+        return headers