add pre-commit configuration file (#59)

* add pre-commit configuration file

* Adding license check files and minor edits to the CI workflow

* Revert most changes to ci

* Add ruff workflow and update package CI + docs shields

* Add SPDX license identifier - BSD-3-Clause

* Add new dependencies setup, update dependencies, new env directions

* Format all files with Ruff

* Fix all Ruff check --fix errors

---------

Co-authored-by: Andrew Tavis McAllister <andrew.t.mcallister@gmail.com>

Author: sayik

.github/workflows/pr_ci.yaml

@@ -0,0 +1,51 @@
+name: pr_ci
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - reopened
+      - synchronize
+    paths:
+      - "src/**"
+      - "tests/**"
+  push:
+    branches:
+      - main
+    paths:
+      - "src/**"
+      - "tests/**"
+
+jobs:
+  ci:
+    name: Run PR Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Project
+        uses: actions/checkout@v4
+
+      - name: Set up Python Environment
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Create Environment and Install Dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv venv
+          . .venv/bin/activate
+          echo PATH=$PATH >> $GITHUB_ENV
+          uv pip install -r requirements-dev.txt
+
+      - name: Run Ruff Format - Formatting Check
+        run: ruff format ./src --check
+
+      - name: Run Ruff - Linting and Import Sorting Check
+        if: always()
+        run: ruff check ./src
+
+      - name: Run mypy - Static Type Checking
+        if: always()
+        run: mypy ./src --config-file ./pyproject.toml

.github/workflows/pr_ci_license_header_check.yaml

@@ -0,0 +1,16 @@
+name: pr_ci_license_header_check
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, reopened, synchronize]
+
+jobs:
+  license_header_check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo Content
+        uses: actions/checkout@v4
+
+      - name: Check License Header
+        uses: apache/skywalking-eyes/header@main

.github/workflows/ci.yml .github/workflows/python_package_ci.yml.github/workflows/ci.yml renamed to .github/workflows/python_package_ci.yml

@@ -1,48 +1,63 @@
-name: CI
-
+name: python_package_ci
 on:
+  workflow_dispatch:
   pull_request:
-    branches: [main]
-  # schedule:
-  #   - cron: '0 0 * * 0' # weekly
+    branches:
+      - main
+    types:
+      - opened
+      - reopened
+      - synchronize
+    paths:
+      - "src/**"
+      - "tests/**"
+  push:
+    branches:
+      - main
+    paths:
+      - "src/**"
+      - "tests/**"
 
 jobs:
   run:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [macos-latest]
-        python-version: [3.8]
+        python-version: [3.11]
+
     env:
       OS: ${{ matrix.os }}
       PYTHON: ${{ matrix.python-version }}
 
     steps:
-      - name: Clone repository
+      - name: Clone Repository
         uses: actions/checkout@v2
+
       - name: Setup Python
         uses: actions/setup-python@main
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Add conda to system path
-        uses: conda-incubator/setup-miniconda@v2
+
+      - name: Add Conda to System Path
+        uses: conda-incubator/setup-miniconda@v3
         with:
           auto-update-conda: true
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+
+      - name: Install Dependencies
         run: |
           eval "$(conda shell.bash hook)"
           conda env create --file environment.yml
-      # - name: Build
-      #     eval "$(conda shell.bash hook)"
-      #     pip install -e .
-      - name: Test and generate coverage
+
+      - name: Test and Generate Coverage
         run: |
           eval "$(conda shell.bash hook)"
           conda activate kwx-dev
           export PYTHONPATH="./src"
           pytest --cov=src tests --cov-report=xml
-      - name: Upload coverage to Codecov
+
+      - name: Upload Coverage to Codecov
         uses: codecov/codecov-action@v2
         with:
           fail_ci_if_error: true

.licenserc.yaml

@@ -0,0 +1,16 @@
+header:
+  license:
+    content: "SPDX-License-Identifier: BSD-3-Clause"
+  paths:
+    - '**/*.py'
+    - '**/*.ts'
+  paths-ignore:
+    - 'build'
+    - 'dist'
+    - 'venv'
+    - '**/*.md'
+    - '**/__pycache__/**'
+    - '**/.git/**'
+    - '**/*__init__.py'
+  comment: on-failure
+  license-location-threshold: 10

.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.1
+    hooks:
+      - id: ruff-check
+        name: run ruff linting check
+        args: [--fix, --exit-non-zero-on-fix]
+
+      - id: ruff-format
+        name: run ruff formatting check
+
+  - repo: https://github.com/tcort/markdown-link-check
+    rev: v3.13.6
+    hooks:
+      - id: markdown-link-check
+        name: run markdown link check
+        args: [-q]
+
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v1.0.0
+    hooks:
+      - id: sphinx-lint
+        name: run sphinx linting
+
+  - repo: https://github.com/numpy/numpydoc
+    rev: v1.9.0
+    hooks:
+      - id: numpydoc-validation
+        files: ^src/
+        exclude: ^(tests/|.*__init__\.py$)
+
+  - repo: https://github.com/to-sta/spdx-checker-pre-commit
+    rev: 0.1.7
+    hooks:
+      - id: spdx-license-checker
+        name: run spdx-checker license check
+        exclude: ^(?:.*/)?__init__\.py$
+        args: [-l, BSD-3-Clause, --fix, --continue-on-error]
+        types_or: [python, ts]
+
+  - repo: local
+    hooks:
+      - id: mypy-check
+        name: run mypy static type checking
+        files: ^src/
+        entry: mypy ./src --config-file ./pyproject.toml
+        language: python
+        types: [python]
+        pass_filenames: false