Merge pull request #5 from madrisan/pylint-workflow

ci: add a job running pylint

Author: madrisan

.github/workflows/ci.yaml

@@ -1,8 +1,8 @@
 name: lint
 on: [push, pull_request]
 jobs:
-  run-linters:
-    name: Run linters
+  ci:
+    name: Run black and pylint tools
     runs-on: ubuntu-latest
 
     steps:
@@ -12,7 +12,12 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.12
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
 
       - name: Install Python dependencies
         run: pip install black flake8
@@ -23,3 +28,7 @@ jobs:
           auto_fix: false
           black: true
           flake8: false
+
+      - name: Analysing the code with pylint
+        run: |
+          uv run pylint --output-format=text ./**/*.py

README.md

@@ -1,5 +1,10 @@
 # Visualize the HadCRUT5 temperature datasets
 
+![Release Status](https://img.shields.io/badge/status-stable-brightgreen.svg)
+![Pylint](images/pylint.svg)
+[![License](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://spdx.org/licenses/GPL-3.0-only.html)
+[![GitHub stars](https://img.shields.io/github/stars/madrisan/HadCRUT5.svg?style=social)](https://github.com/madrisan/HadCRUT5/stargazers)
+
 > HadCRUT5 is a gridded dataset of global historical surface temperature anomalies relative to a 1961-1990 reference period.
 > Data are available for each month from January 1850 onwards, on a 5 degree grid and as global and regional average time series.
 > The dataset is a collaborative product of the Met Office Hadley Centre and the Climatic Research Unit at the University of East Anglia.

images/pylint.svg

@@ -0,0 +1,16 @@
+uv run pylint \
+   --verbose \
+   --output-format=text ./**/*.py \
+| tee pylint-log.txt
+
+score="$(
+   sed -n "/^Your code has been rated at/{s,.* at \([0-9\.]*\)\/.*,\1,p}" \
+      pylint-log.txt)"
+
+uv run anybadge \
+   --file="images/pylint.svg" \
+   --label "pylint" \
+   --overwrite \
+   --value "$score"
+
+rm -f pylint-log.txt

pylint.sh

@@ -13,6 +13,7 @@ dependencies = [
 
 [dependency-groups]
 dev = [
+    "anybadge>=1.14.0",
     "black>=24.10.0",
     "mypy>=1.14.0",
     "pylint>=3.3.2",