Merge remote-tracking branch 'skeleton/main' into test-pyahocorasick

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

.github/workflows/docs-ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.12]
+        python-version: [3.13]
 
     steps:
       - name: Checkout code
@@ -24,14 +24,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
 
 

.gitignore

@@ -114,3 +114,5 @@ selenium
 
 # Ignore extra rpmdb sqlite stuff
 rpmdb.sqlite-*
+/.ruff_cache/
+.env

.readthedocs.yml

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

MANIFEST.in

@@ -1,4 +1,6 @@
 graft src
+graft docs
+graft etc
 
 graft thirdparty
 graft etc/thirdparty
@@ -10,6 +12,7 @@ include *.ABOUT
 include *.toml
 include *.yml
 include *.rst
+include *.png
 include setup.*
 include configure*
 include requirements*
@@ -22,7 +25,14 @@ include scancode*
 include PYTHON_EXECUTABLE
 
 include Dockerfile
+include .dockerignore
+include .gitignore
+include .readthedocs.yml
+include manage.py
+include Dockerfile*
+include Makefile
+include MANIFEST.in
+
 include .VERSION
 
 global-exclude *.py[co] __pycache__ *.*~
-

Makefile

@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# ScanCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/aboutcode-org/skeleton for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+# Python version can be specified with `$ PYTHON_EXE=python3.x make conf`
+PYTHON_EXE?=python3
+VENV=venv
+ACTIVATE?=. ${VENV}/bin/activate;
+
+
+conf:
+	@echo "-> Install dependencies"
+	./configure
+
+dev:
+	@echo "-> Configure and install development dependencies"
+	./configure --dev
+
+doc8:
+	@echo "-> Run doc8 validation"
+	@${ACTIVATE} doc8 --quiet docs/ *.rst
+
+valid:
+	@echo "-> Run Ruff format"
+	@${ACTIVATE} ruff format
+	@echo "-> Run Ruff linter"
+	@${ACTIVATE} ruff check --fix
+
+check:
+	@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"
+	./configure --clean
+
+test:
+	@echo "-> Run the test suite"
+	${VENV}/bin/pytest -vvs
+
+docs:
+	rm -rf 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 clean test docs docs-check

README.rst

@@ -207,197 +207,3 @@ and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/
 
 
 Support
-=======
-
-If you have a problem, a suggestion or found a bug, please enter a ticket at:
-https://github.com/nexB/scancode-toolkit/issues
-
-For discussions and chats, we have:
-
-* an official Gitter channel for `web-based chats
-  <https://matrix.to/#/#aboutcode-org_discuss:gitter.im>`_.
-  Gitter is now accessible through `Element <https://element.io/download>`_
-  or an `IRC bridge <https://matrix-org.github.io/matrix-appservice-irc/latest/usage.html>`_.
-  There are other AboutCode project-specific channels available there too.
-
-* The discussion channel for `scancode <https://matrix.to/#/#aboutcode-org_scancode:gitter.im>`_
-  specifically aimed at users and developers using scancode-toolkit.
-
-Source code and downloads
-=========================
-
-* https://github.com/nexB/scancode-toolkit/releases
-* https://github.com/nexB/scancode-toolkit.git
-* https://pypi.org/project/scancode-toolkit/
-* https://github.com/nexB/scancode-thirdparty-src.git
-* https://github.com/nexB/scancode-plugins.git
-* https://github.com/nexB/thirdparty-packages.git
-
-License
-=======
-
-* Apache-2.0 as the overall license
-* CC-BY-4.0 for reference datasets (initially was in the Public Domain).
-* Multiple other secondary permissive or copyleft licenses (LGPL, MIT,
-  BSD, GPL 2/3, etc.) for third-party components and test suite code and data.
-
-
-See the NOTICE file and the .ABOUT files that document the origin and license of
-the third-party code used in ScanCode for more details.
-
-
-
-.. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop
-    :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop
-    :alt: Azure tests status (Linux, macOS, Windows)
-
-.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=latest
-    :target: https://scancode-toolkit.readthedocs.io/en/latest/?badge=latest
-    :alt: Documentation Status
-
-.. |docs-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml/badge.svg?branch=develop
-    :target: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml
-    :alt: Documentation Tests
-
-.. |release-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml/badge.svg?event=push
-    :target: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml
-    :alt: Release tests
-
-
-Acknowledgements, Funding, Support and Sponsoring
---------------------------------------------------------
-
-This project is funded, supported and sponsored by:
-
-- Generous support and contributions from users like you!
-- the European Commission NGI programme
-- the NLnet Foundation 
-- the Swiss State Secretariat for Education, Research and Innovation (SERI)
-- Google, including the Google Summer of Code and the Google Seasons of Doc programmes
-- Mercedes-Benz Group
-- Microsoft and Microsoft Azure
-- AboutCode ASBL
-- nexB Inc. 
-
-
-
-|europa|   |dgconnect| 
-
-|ngi|   |nlnet|   
-
-|aboutcode|  |nexb|
-
-
-This project was funded through the NGI0 Discovery Fund, a fund established by NLnet with financial
-support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 825322.
-
-|ngidiscovery| https://nlnet.nl/project/vulnerabilitydatabase/
-
-
-This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
-support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 101069594. 
-
-|ngizeroentrust| https://nlnet.nl/project/Back2source/
-
-
-This project was funded through the NGI0 Core Fund, a fund established by NLnet with financial
-support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 101092990.
-
-|ngizerocore| https://nlnet.nl/project/Back2source-next/
-
-
-This project was funded through the NGI0 Core Fund, a fund established by NLnet with financial
-support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 101092990. 
-
-|ngizerocore| https://nlnet.nl/project/FastScan/
-
-
-This project was funded through the NGI0 Commons Fund, a fund established by NLnet with financial
-support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 101135429. Additional
-funding is made available by the Swiss State Secretariat for Education, Research and Innovation
-(SERI).
-
-|ngizerocommons| |swiss| https://nlnet.nl/project/MassiveFOSSscan/
-
-This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
-support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 101069594. 
-
-|ngizeroentrust| https://nlnet.nl/project/purl2sym/
-
-
-.. |nlnet| image:: https://nlnet.nl/logo/banner.png
-    :target: https://nlnet.nl
-    :height: 50
-    :alt: NLnet foundation logo
-
-.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png
-    :target: https://ngi.eu35
-    :height: 50
-    :alt: NGI logo
-
-.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg
-    :target: https://nexb.com
-    :height: 30
-    :alt: nexB logo
-
-.. |europa| image:: https://ngi.eu/wp-content/uploads/sites/77/2017/10/bandiera_stelle.png
-    :target: http://ec.europa.eu/index_en.htm
-    :height: 40
-    :alt: Europa logo
-
-.. |aboutcode| image:: https://aboutcode.org/wp-content/uploads/2023/10/AboutCode.svg
-    :target: https://aboutcode.org/
-    :height: 30
-    :alt: AboutCode logo
-
-.. |swiss| image:: https://www.sbfi.admin.ch/sbfi/en/_jcr_content/logo/image.imagespooler.png/1493119032540/logo.png
-    :target: https://www.sbfi.admin.ch/sbfi/en/home/seri/seri.html
-    :height: 40
-    :alt: Swiss logo
-
-.. |dgconnect| image:: https://commission.europa.eu/themes/contrib/oe_theme/dist/ec/images/logo/positive/logo-ec--en.svg
-    :target: https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en
-    :height: 40
-    :alt: EC DG Connect logo
-
-.. |ngizerocore| image:: https://nlnet.nl/image/logos/NGI0_tag.svg
-    :target: https://nlnet.nl/core
-    :height: 40
-    :alt: NGI Zero Core Logo
-
-.. |ngizerocommons| image:: https://nlnet.nl/image/logos/NGI0_tag.svg
-    :target: https://nlnet.nl/commonsfund/
-    :height: 40
-    :alt: NGI Zero Commons Logo
-
-.. |ngizeropet| image:: https://nlnet.nl/image/logos/NGI0PET_tag.svg
-    :target: https://nlnet.nl/PET
-    :height: 40
-    :alt: NGI Zero PET logo
-
-.. |ngizeroentrust| image:: https://nlnet.nl/image/logos/NGI0Entrust_tag.svg
-    :target: https://nlnet.nl/entrust
-    :height: 38
-    :alt: NGI Zero Entrust logo
-
-.. |ngiassure| image:: https://nlnet.nl/image/logos/NGIAssure_tag.svg
-    :target: https://nlnet.nl/image/logos/NGIAssure_tag.svg
-    :height: 32
-    :alt: NGI Assure logo
-
-.. |ngidiscovery| image:: https://nlnet.nl/image/logos/NGI0Discovery_tag.svg
-    :target: https://nlnet.nl/discovery/
-    :height: 40
-    :alt: NGI Discovery logo
-
-
-
-
-
-

azure-pipelines.yml

@@ -155,7 +155,7 @@ jobs:
 
     - template: etc/ci/azure-win.yml
       parameters:
-          job_name: win2019_cpython_1
+          job_name: win2025_cpython
           image_name: windows-2025
           python_versions: ['3.9']
           python_architecture: x64
@@ -171,25 +171,6 @@ jobs:
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs tests\scancode\test_cli.py --reruns 2
 
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2022_cpython_1
-          image_name: windows-2022
-          python_versions: ['3.9']
-          python_architecture: x64
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs tests\scancode\test_cli.py --reruns 2
-
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2022_cpython_2
-          image_name: windows-2022
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          python_architecture: x64
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs tests\scancode\test_cli.py --reruns 2
-
-
 ################################################################################
 # Test using many version of Click to work around any regressions in their API
 ################################################################################
@@ -270,5 +251,5 @@ jobs:
 
     - template: etc/ci/azure-posix-docker.yml
       parameters:
-          job_name: ubuntu22_build_container
-          image_name: ubuntu-22.04
+          job_name: ubuntu24_build_container
+          image_name: ubuntu-24.04