Merge pull request #81 from a5chin/feature/nox

Add Nox as task runner

Author: a5chin

.coveragerc

@@ -1,4 +1,5 @@
 [run]
 omit =
+    **/__init__.py
     noxfile.py
     tests/*

.dockerignore

@@ -182,6 +182,7 @@
 .pre-commit-config.yaml
 assets
 LICENSE
+noxfile.py
 pyrightconfig.json
 README.md
 ruff.toml

.github/workflows/pyright.yml renamed to .github/workflows/format.yml

@@ -1,4 +1,4 @@
-name: Pyright
+name: Format
 
 on:
   push:
@@ -7,14 +7,21 @@ on:
     branches: [main]
 
 jobs:
-  type-check:
+  ruff:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: jakebailey/pyright-action@v2
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }} with uv
+        uses: ./.github/actions/setup-python-with-uv
         with:
           python-version: ${{ matrix.python-version }}
+
+      - name: Format by Ruff
+        run: uv run nox -s fmt

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  pyright-and-ruff:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }} with uv
+        uses: ./.github/actions/setup-python-with-uv
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Lint by Pyright and Ruff
+        run: uv run nox -s lint

.github/workflows/ruff.yml

@@ -0,0 +1,83 @@
+from typing import Any
+
+import nox
+from pydantic_settings import BaseSettings
+
+
+class CLIArgs(
+    BaseSettings,
+    cli_ignore_unknown_args=True,
+):
+    """CLIArgs is a class that extends BaseSettings to handle command line arguments."""
+
+    @classmethod
+    def parse(cls, posargs: list[str]) -> "CLIArgs":
+        """Parse command line arguments from the provided list.
+
+        Args:
+            posargs (list[str]): List of positional arguments from the command line.
+
+        Returns:
+            CLIArgs: An instance of `CLIArgs` populated with the parsed arguments.
+
+        """
+        arg_name: str | None = None
+        kwargs: dict[str, Any] = {}
+
+        for arg in posargs:
+            if arg.startswith("--"):
+                arg_name = arg[2:]
+            elif arg_name is not None:
+                kwargs[arg_name] = arg
+                arg_name = None
+
+        return cls(**kwargs)
+
+
+@nox.session(python=False)
+def fmt(session: nox.Session) -> None:
+    """Format the code using Ruff.
+
+    Args:
+        session (nox.Session): The Nox session object.
+
+    Examples:
+        >>> uv run nox -s fmt
+
+    """
+    session.run("uv", "run", "ruff", "format", ".")
+
+    session.log("✅ Formatting completed successfully.")
+
+
+@nox.session(python=False)
+def lint(session: nox.Session) -> None:
+    """Lint the code using Pyright and Ruff.
+
+    Args:
+        session (nox.Session): The Nox session object.
+
+    Examples:
+        >>> uv run nox -s lint
+
+    """
+    session.run("uv", "run", "pyright")
+    session.run("uv", "run", "ruff", "check", ".", "--fix")
+
+    session.log("✅ Linting completed successfully.")
+
+
+@nox.session(python=False)
+def test(session: nox.Session) -> None:
+    """Run tests using pytest.
+
+    Args:
+        session (nox.Session): The Nox session object.
+
+    Examples:
+        >>> uv run nox -s test
+
+    """
+    session.run("uv", "run", "pytest")
+
+    session.log("✅ Testing completed successfully.")

noxfile.py

@@ -21,6 +21,7 @@ dev-dependencies = [
     "cookiecutter>=2.6.0",
     "cookiecutter-data-science>=2.1.0",
     "mkdocs-material>=9.5.50",
+    "nox>=2025.5.1",
     "pre-commit>=4.1.0",
     "pyright>=1.1.392.post0",
     "pytest>=8.3.4",