Setup pre-commit and github actions to run tests

Author: mohilpatel25

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  # Triggers the workflow on pull request events but only for the "main" branch
+  pull_request:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  python-style-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install requirements
+        run: pip install -r requirements.txt
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files
+
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install requirements
+        run: pip install -r requirements.txt
+
+      - name: Run tests
+        run: pytest --cov --cov-fail-under=90 # Fail tests if coverage is below 90%

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: name-tests-test
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.17.0
+    hooks:
+      - id: pyupgrade
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.8.0
+    hooks:
+      - id: black-jupyter
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort

requirements.txt

@@ -0,0 +1,3 @@
+pre-commit==3.8.0
+pytest==8.3.3
+pytest-cov==5.0.0

src/example.py

@@ -0,0 +1,18 @@
+"""Module docstring."""
+
+from typing import Any
+
+
+class Example:
+    """Example class docstring."""
+
+    def __init__(self, variable: Any = None) -> None:
+        self.variable = variable
+
+    def function(self, *args: Any, **kwargs: Any) -> int:
+        """Function docstring.
+
+        Returns:
+            int: Number of arguments passed
+        """
+        return len(args) + len(kwargs)

src/example_test.py

@@ -0,0 +1,33 @@
+"""Tests for example module."""
+
+from typing import Any
+
+import pytest
+
+from src import example
+
+
+class TestExample:
+    """Testcases for Example class"""
+
+    def test_init(self) -> None:
+        """Test init."""
+
+        obj = example.Example("test_variable")
+        assert obj.variable == "test_variable"
+
+    @pytest.mark.parametrize(
+        "args,kwargs,expected_num_args",
+        [
+            ((1, 2, "A"), {}, 3),
+            ((), {"A": "A"}, 1),
+            (("A", "B"), {"a": "a"}, 3),
+            (("A", "B"), {}, 2),
+        ],
+    )
+    def test_function(self, args: Any, kwargs: Any, expected_num_args: int) -> None:
+        """Test function."""
+
+        obj = example.Example()
+        num_args = obj.function(*args, **kwargs)
+        assert num_args == expected_num_args