Merge pull request #90 from aboutcode-org/release-prep-32.3.0

Release prep 32.3.0

Author: AyanSinhaMahapatra

.github/workflows/docs-ci.yml

@@ -21,15 +21,13 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install Dependencies
-        run:  pip install -e .[docs,testing]
+        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
 
       - name: Check for Code style errors
-        run: make check-ci
+        run: make check

.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

@@ -11,4 +11,5 @@ The following organizations or individuals have contributed to this repo:
 - Saravanan G @SaravananOffl
 - Sebastian Schuberth @sschuberth
 - Steven Esser @majurg
+- Theodore Aptekarev @piiq
 - Thomas Druez @tdruez

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Release notes
 =============
 
+Version 32.3.0 - (2025-03-06)
+-----------------------------
+
+- Fix ``click`` compatibililty issues.
+  https://github.com/aboutcode-org/commoncode/pull/89
+  https://github.com/aboutcode-org/commoncode/pull/86
+
 Version 32.2.1 - (2025-03-06)
 -----------------------------
 
@@ -35,7 +42,8 @@ Version 32.0.0 - (2024-09-05)
 Version 31.2.1 - (2024-05-16)
 -----------------------------
 
-- Remove ``commoncode.system.get_etc_os_release_info`` and replace it with ``commoncode.distro_os_release_parser``.
+- Remove ``commoncode.system.get_etc_os_release_info`` and replace it with
+  ``commoncode.distro_os_release_parser``.
 
 
 Version 31.2.0 - (2024-05-16)

MANIFEST.in

@@ -1,15 +1,26 @@
 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 .giti*
+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,39 +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,scripts,tests,migrations,settings.py,.cache .
-	@echo "-> Run isort imports ordering validation"
-	@${ACTIVATE} isort --sl -l 100 src tests setup.py --check-only
-	@echo "-> Run black validation"
-	@${ACTIVATE} black --check -l 100 src tests setup.py
-
-check-ci:
-	@echo "-> Run pycodestyle (PEP8) validation"
-	pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,scripts,tests,migrations,settings.py,.cache .
-	@echo "-> Run isort imports ordering validation"
-	isort --sl -l 100 src tests setup.py --check-only
-	@echo "-> Run black validation"
-	black --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"
@@ -57,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

azure-pipelines.yml

@@ -43,8 +43,8 @@ jobs:
 
   - template: etc/ci/azure-win.yml
     parameters:
-      job_name: win2019_cpython
-      image_name: windows-2019
+      job_name: win2025_cpython
+      image_name: windows-2025
       python_versions: ["3.9", "3.10", "3.11", "3.12", "3.13"]
       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

configure.bat

@@ -27,8 +27,7 @@
 
 @rem # Requirement arguments passed to pip and used by default or with --dev.
 set "REQUIREMENTS=--editable . --constraint requirements.txt"
-set "DEV_REQUIREMENTS=--editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
-set "DOCS_REQUIREMENTS=--editable .[docs] --constraint requirements.txt"
+set "DEV_REQUIREMENTS=--editable .[dev] --constraint requirements.txt --constraint requirements-dev.txt"
 
 @rem # where we create a virtualenv
 set "VIRTUALENV_DIR=venv"
@@ -76,9 +75,6 @@ if not "%1" == "" (
     if "%1" EQU "--dev"    (
         set "CFG_REQUIREMENTS=%DEV_REQUIREMENTS%"
     )
-    if "%1" EQU "--docs"    (
-        set "CFG_REQUIREMENTS=%DOCS_REQUIREMENTS%"
-    )
     shift
     goto again
 )

docs/Makefile

@@ -7,7 +7,7 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
-BUILDDIR      = build
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

docs/scripts/doc8_style_check.sh

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "nexb-skeleton"
-copyright = "nexB Inc. and others."
+copyright = "nexB Inc., AboutCode and others."
 author = "AboutCode.org authors and contributors"
 
 
@@ -94,7 +94,8 @@
 html_show_sphinx = True
 
 # Define CSS and HTML abbreviations used in .rst files.  These are examples.
-# .. role:: is used to refer to styles defined in _static/theme_overrides.css and is used like this: :red:`text`
+# .. role:: is used to refer to styles defined in _static/theme_overrides.css
+# and is used like this: :red:`text`
 rst_prolog = """
 .. |psf| replace:: Python Software Foundation