Merge pull request #96 from aboutcode-org/add-code-style-checks

Add code style checks

Author: pombredanne

.github/workflows/docs-ci.yml

@@ -21,14 +21,12 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install Dependencies
-        run:  pip install -e .[docs]
+        run:  ./configure --dev
 
-      - name: Check Sphinx Documentation build minimally
-        working-directory: ./docs
-        run: sphinx-build -E -W source build
+      - name: Check documentation and HTML for errors and dead links
+        run: make docs-check
 
-      - name: Check for documentation style errors
-        working-directory: ./docs
-        run: ./scripts/doc8_style_check.sh
+      - name: Check documentation for style errors
+        run: make doc8
 
 

.github/workflows/pypi-release.yml

@@ -30,12 +30,15 @@ jobs:
         with:
           python-version: 3.12
 
-      - name: Install pypa/build
-        run: python -m pip install build --user
+      - name: Install pypa/build and twine
+        run: python -m pip install --user build twine
 
       - name: Build a binary wheel and a source tarball
         run: python -m build --sdist --wheel --outdir dist/
 
+      - name: Validate wheel and sdis for Pypi
+        run: python -m twine check dist/*
+
       - name: Upload built archives
         uses: actions/upload-artifact@v4
         with:

.gitignore

@@ -72,3 +72,5 @@ tcl
 
 # Ignore Jupyter Notebook related temp files
 .ipynb_checkpoints/
+/.ruff_cache/
+.env

.readthedocs.yml

@@ -26,4 +26,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - dev

AUTHORS.rst

@@ -1,3 +1,3 @@
 The following organizations or individuals have contributed to this repo:
 
-- 
+-

MANIFEST.in

@@ -1,15 +1,25 @@
 graft src
+graft docs
+graft etc
 
 include *.LICENSE
 include NOTICE
 include *.ABOUT
 include *.toml
 include *.yml
 include *.rst
+include *.png
 include setup.*
 include configure*
 include requirements*
-include .git*
+include .dockerignore
+include .gitignore
+include .readthedocs.yml
+include manage.py
+include Dockerfile*
+include Makefile
+include MANIFEST.in
 
-global-exclude *.py[co] __pycache__ *.*~
+include .VERSION
 
+global-exclude *.py[co] __pycache__ *.*~

Makefile

@@ -13,31 +13,33 @@ PYTHON_EXE?=python3
 VENV=venv
 ACTIVATE?=. ${VENV}/bin/activate;
 
-dev:
-	@echo "-> Configure the development envt."
-	./configure --dev
 
-isort:
-	@echo "-> Apply isort changes to ensure proper imports ordering"
-	${VENV}/bin/isort --sl -l 100 src tests setup.py
+conf:
+	@echo "-> Install dependencies"
+	./configure
 
-black:
-	@echo "-> Apply black code formatter"
-	${VENV}/bin/black -l 100 src tests setup.py
+dev:
+	@echo "-> Configure and install development dependencies"
+	./configure --dev
 
 doc8:
 	@echo "-> Run doc8 validation"
-	@${ACTIVATE} doc8 --max-line-length 100 --ignore-path docs/_build/ --quiet docs/
+	@${ACTIVATE} doc8 --quiet docs/ *.rst
 
-valid: isort black
+valid:
+	@echo "-> Run Ruff format"
+	@${ACTIVATE} ruff format
+	@echo "-> Run Ruff linter"
+	@${ACTIVATE} ruff check --fix
 
 check:
-	@echo "-> Run pycodestyle (PEP8) validation"
-	@${ACTIVATE} pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,migrations,settings.py,.cache .
-	@echo "-> Run isort imports ordering validation"
-	@${ACTIVATE} isort --sl --check-only -l 100 setup.py src tests .
-	@echo "-> Run black validation"
-	@${ACTIVATE} black --check --check -l 100 src tests setup.py
+	@echo "-> Run Ruff linter validation (pycodestyle, bandit, isort, and more)"
+	@${ACTIVATE} ruff check
+	@echo "-> Run Ruff format validation"
+	@${ACTIVATE} ruff format --check
+	@$(MAKE) doc8
+	@echo "-> Run ABOUT files validation"
+	@${ACTIVATE} about check etc/
 
 clean:
 	@echo "-> Clean the Python env"
@@ -49,6 +51,10 @@ test:
 
 docs:
 	rm -rf docs/_build/
-	@${ACTIVATE} sphinx-build docs/ docs/_build/
+	@${ACTIVATE} sphinx-build docs/source docs/_build/
+
+docs-check:
+	@${ACTIVATE} sphinx-build -E -W -b html docs/source docs/_build/
+	@${ACTIVATE} sphinx-build -E -W -b linkcheck docs/source docs/_build/
 
-.PHONY: conf dev check valid black isort clean test docs
+.PHONY: conf dev check valid clean test docs docs-check

README.rst

@@ -1,11 +1,10 @@
 A Simple Python Project Skeleton
 ================================
 
-This repo attempts to standardize the structure of the Python-based project's repositories using
-modern Python packaging and configuration techniques that can then be applied to many repos.
-
-Using this `blog post`_ as inspiration, this repository serves as the base for all new Python
-projects and is mergeable in existing repositories as well.
+This repo attempts to standardize the structure of the Python-based project's
+repositories using modern Python packaging and configuration techniques.
+Using this `blog post`_ as inspiration, this repository serves as the base for
+all new Python projects and is mergeable in existing repositories as well.
 
 .. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
 
@@ -45,6 +44,10 @@ More usage instructions can be found in ``docs/skeleton-usage.rst``.
 Release Notes
 =============
 
+- 2025-03-31:
+
+    - Use ruff as the main code formatting tool, add ruff rules to pyproject.toml
+
 - 2025-03-29:
 
     - Add support for beta macOS-15
@@ -69,7 +72,7 @@ Release Notes
 
     - Drop support for Python 3.8
     - Drop support for macOS-11, add support for macOS-14
-    
+
 - 2024-02-19:
 
     - Replace support in CI of default ubuntu-20.04 by ubuntu-22.04
@@ -86,19 +89,19 @@ Release Notes
 
     - Synchronize configure and configure.bat scripts for sanity
     - Update CI operating system support with latest Azure OS images
-    - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies
-      There are now fewer scripts. See etc/scripts/README.rst for details
+    - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party
+      dependencies. There are now fewer scripts. See etc/scripts/README.rst for details
 
 - 2021-09-03:
-    
-    - ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` and ``requirements-dev.txt``
-    
+    - ``configure`` now requires pinned dependencies via the use of ``requirements.txt``
+      and ``requirements-dev.txt``
     - ``configure`` can now accept multiple options at once
     - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files
     - Rename virtual environment directory from ``tmp`` to ``venv``
-    - Update README.rst with instructions for generating ``requirements.txt`` and ``requirements-dev.txt``,
-      as well as collecting dependencies as wheels and generating ABOUT files for them.
+    - Update README.rst with instructions for generating ``requirements.txt``
+      and ``requirements-dev.txt``, as well as collecting dependencies as wheels and generating
+      ABOUT files for them.
 
 - 2021-05-11:
-
-    - Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used.
+    - Adopt new configure scripts from ScanCode TK that allows correct configuration of which
+      Python version is used.

azure-pipelines.yml

@@ -7,90 +7,74 @@
 
 jobs:
 
+    - template: etc/ci/azure-posix.yml
+      parameters:
+          job_name: run_code_checks
+          image_name: ubuntu-24.04
+          python_versions: ['3.12']
+          test_suites:
+              all: make check
+
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu22_cpython
           image_name: ubuntu-22.04
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu24_cpython
           image_name: ubuntu-24.04
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos13_cpython
-          image_name: macOS-13-xlarge
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos13_cpython_arm64
           image_name: macOS-13
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos14_cpython
-          image_name: macOS-14-large
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos14_cpython_arm64
           image_name: macOS-14
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos15_cpython
           image_name: macOS-15
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos15_cpython_arm64
-          image_name: macOS-15-large
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-win.yml
       parameters:
           job_name: win2019_cpython
           image_name: windows-2019
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs
 
     - template: etc/ci/azure-win.yml
       parameters:
           job_name: win2022_cpython
           image_name: windows-2022
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs
 
     - template: etc/ci/azure-win.yml
       parameters:
           job_name: win2025_cpython
           image_name: windows-2025
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.9', '3.10', '3.11', '3.12']
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs

configure

@@ -29,14 +29,13 @@ CLI_ARGS=$1
 
 # Requirement arguments passed to pip and used by default or with --dev.
 REQUIREMENTS="--editable . --constraint requirements.txt"
-DEV_REQUIREMENTS="--editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
-DOCS_REQUIREMENTS="--editable .[docs] --constraint requirements.txt"
+DEV_REQUIREMENTS="--editable .[dev] --constraint requirements.txt --constraint requirements-dev.txt"
 
 # where we create a virtualenv
 VIRTUALENV_DIR=venv
 
 # Cleanable files and directories to delete with the --clean option
-CLEANABLE="build dist venv .cache .eggs"
+CLEANABLE="build dist venv .cache .eggs *.egg-info docs/_build/ pip-selfcheck.json"
 
 # extra  arguments passed to pip
 PIP_EXTRA_ARGS=" "
@@ -168,6 +167,7 @@ clean() {
     for cln in $CLEANABLE;
         do rm -rf "${CFG_ROOT_DIR:?}/${cln:?}";
     done
+    find . -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete
     set +e
     exit
 }
@@ -185,7 +185,6 @@ while getopts :-: optchar; do
                 help  ) cli_help;;
                 clean ) find_python && clean;;
                 dev   ) CFG_REQUIREMENTS="$DEV_REQUIREMENTS";;
-                docs   ) CFG_REQUIREMENTS="$DOCS_REQUIREMENTS";;
             esac;;
     esac
 done