Merge pull request #115 from aboutcode-org/release-prep-v30.4.2

Release v30.4.2

Author: AyanSinhaMahapatra

.github/workflows/docs-ci.yml

@@ -4,31 +4,29 @@ on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.9]
+        python-version: [3.13]
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           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: python3 -m sphinx -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

@@ -26,18 +26,21 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          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 --upgrade build twine pkginfo
 
       - name: Build a binary wheel and a source tarball
-        run: python -m build --sdist --wheel --outdir dist/
+        run: python -m build --sdist --outdir dist/
+
+      - name: Validate wheel and sdis for Pypi
+        run: python -m twine check dist/*
 
       - name: Upload built archives
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pypi_archives
           path: dist/*
@@ -54,13 +57,13 @@ jobs:
 
     steps:
       - name: Download built archives
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: pypi_archives
           path: dist
 
       - name: Create GH release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           draft: true
           files: dist/*
@@ -74,7 +77,7 @@ jobs:
 
     steps:
       - name: Download built archives
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: pypi_archives
           path: dist

.gitignore

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

.readthedocs.yml

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

AUTHORS.rst

@@ -8,8 +8,10 @@ The following organizations or individuals have contributed to this code:
 - Jono Yang @JonoYang
 - Max Mehl @mxmehl
 - nexB Inc. @nexB
+- Pablo Castellazzi @pcastellazzi
 - Peter Kolbus @pkolbus
 - Philippe Ombredanne @pombredanne
 - Sebastian Schuberth @sschuberth
 - Steven Esser @majurg
 - Thomas Druez @tdruez
+- Uwe L. Korn @xhochy

CHANGELOG.rst

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+v30.4.2 - 2025-06-25
+--------------------
+
+This is a minor release without API changes:
+
+- Use latest skeleton
+- Update license list to latest ScanCode
+
+
 v30.4.1 - 2025-01-10
 --------------------
 

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,31 @@ 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
 
 clean:
 	@echo "-> Clean the Python env"
@@ -49,6 +49,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

@@ -34,9 +34,8 @@ license expression engine in several projects and products such as:
 
 - AboutCode-toolkit https://github.com/aboutcode-org/aboutcode-toolkit
 - AlekSIS (School Information System) https://edugit.org/AlekSIS/official/AlekSIS-Core
-- Barista https://github.com/Optum/barista
 - Conda forge tools https://github.com/conda-forge/conda-smithy
-- DejaCode https://dejacode.com
+- DejaCode https://enterprise.dejacode.com
 - DeltaCode https://github.com/nexB/deltacode
 - FenixscanX https://github.com/SmartsYoung/FenixscanX
 - FetchCode https://github.com/aboutcode-org/fetchcode
@@ -49,7 +48,7 @@ license expression engine in several projects and products such as:
 - SecObserve https://github.com/MaibornWolff/SecObserve
 
 See also for details:
-- https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/
+- https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions
 
 ``license-expression`` is also packaged for most Linux distributions. See below.
 
@@ -65,17 +64,6 @@ libraries in other languages (but not as powerful of course!):
 - Ada https://github.com/Fabien-Chouteau/spdx_ada
 - Java https://github.com/spdx/tools and https://github.com/aschet/spdx-license-expression-tools
 
-Build and tests status
-======================
-
-+--------------------------+------------------------+----------------------------------+
-|**Linux & macOS (Travis)**| **Windows (AppVeyor)** |**Linux, Windows & macOS (Azure)**|
-+==========================+========================+==================================+
-|                          |                        |                                  |
-| |travis-badge-icon|      | |appveyor-badge-icon|  |   |azure-badge-icon|             |
-|                          |                        |                                  |
-+--------------------------+------------------------+----------------------------------+
-
 Source code and download
 ========================
 
@@ -125,36 +113,36 @@ validate, compare, simplify and normalize license expressions.
 
 Create an SPDX Licensing and parse expressions::
 
-	>>> from license_expression import get_spdx_licensing
-	>>> licensing = get_spdx_licensing()
-	>>> expression = ' GPL-2.0 or LGPL-2.1 and mit '
-	>>> parsed = licensing.parse(expression)
-	>>> print(parsed.pretty())
-	OR(
-	  LicenseSymbol('GPL-2.0-only'),
-	  AND(
-	    LicenseSymbol('LGPL-2.1-only'),
-	    LicenseSymbol('MIT')
-	  )
-	)
-
-	>>> str(parsed)
-	'GPL-2.0-only OR (LGPL-2.1-only AND MIT)'
-
-	>>> licensing.parse('unknwon with foo', validate=True, strict=True)
-	license_expression.ExpressionParseError: A plain license symbol cannot be used
-	as an exception in a "WITH symbol" statement. for token: "foo" at position: 13
-
-	>>> licensing.parse('unknwon with foo', validate=True)
-	license_expression.ExpressionError: Unknown license key(s): unknwon, foo
-
-	>>> licensing.validate('foo and MIT and GPL-2.0+')
-	ExpressionInfo(
-	    original_expression='foo and MIT and GPL-2.0+',
-	    normalized_expression=None,
-	    errors=['Unknown license key(s): foo'],
-	    invalid_symbols=['foo']
-	)
+    >>> from license_expression import get_spdx_licensing
+    >>> licensing = get_spdx_licensing()
+    >>> expression = ' GPL-2.0 or LGPL-2.1 and mit '
+    >>> parsed = licensing.parse(expression)
+    >>> print(parsed.pretty())
+    OR(
+      LicenseSymbol('GPL-2.0-only'),
+      AND(
+        LicenseSymbol('LGPL-2.1-only'),
+        LicenseSymbol('MIT')
+      )
+    )
+
+    >>> str(parsed)
+    'GPL-2.0-only OR (LGPL-2.1-only AND MIT)'
+
+    >>> licensing.parse('unknwon with foo', validate=True, strict=True)
+    license_expression.ExpressionParseError: A plain license symbol cannot be used
+    as an exception in a "WITH symbol" statement. for token: "foo" at position: 13
+
+    >>> licensing.parse('unknwon with foo', validate=True)
+    license_expression.ExpressionError: Unknown license key(s): unknwon, foo
+
+    >>> licensing.validate('foo and MIT and GPL-2.0+')
+    ExpressionInfo(
+        original_expression='foo and MIT and GPL-2.0+',
+        normalized_expression=None,
+        errors=['Unknown license key(s): foo'],
+        invalid_symbols=['foo']
+    )
 
 
 Create a simple Licensing and parse expressions::
@@ -243,20 +231,3 @@ Development
 - On Windows run  ``configure.bat --dev`` and then ``Scripts\bin\activate`` instead.
 
 - To run the tests, run ``pytest -vvs``
-
-
-.. |travis-badge-icon| image:: https://api.travis-ci.org/nexB/license-expression.png?branch=master
-    :target: https://travis-ci.org/nexB/license-expression
-    :alt: Travis tests status
-    :align: middle
-
-.. |appveyor-badge-icon| image:: https://ci.appveyor.com/api/projects/status/github/nexB/license-expression?svg=true
-    :target: https://ci.appveyor.com/project/nexB/license-expression
-    :alt: Appveyor tests status
-    :align: middle
-
-.. |azure-badge-icon| image:: https://dev.azure.com/nexB/license-expression/_apis/build/status/nexB.license-expression?branchName=master
-    :target: https://dev.azure.com/nexB/license-expression/_build/latest?definitionId=2&branchName=master
-    :alt: Azure pipelines tests status
-    :align: middle
-

azure-pipelines.yml

@@ -5,6 +5,14 @@
 ################################################################################
 
 jobs:
+  - template: etc/ci/azure-posix.yml
+    parameters:
+        job_name: run_code_checks
+        image_name: ubuntu-24.04
+        python_versions: ['3.13']
+        test_suites:
+            all: make check
+
   - template: etc/ci/azure-posix.yml
     parameters:
       job_name: ubuntu22_cpython
@@ -39,8 +47,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