aboutcode-org
diff --git a/‎.github/workflows/pypi-release.yml‎
Lines changed: 14 additions & 11 deletions b/‎.github/workflows/pypi-release.yml‎
Lines changed: 14 additions & 11 deletions
diff --git a/‎.gitignore‎
Lines changed: 1 addition & 2 deletions b/‎.gitignore‎
Lines changed: 1 addition & 2 deletions
diff --git a/‎.readthedocs.yml‎
Lines changed: 1 addition & 1 deletion b/‎.readthedocs.yml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎CHANGELOG.rst‎
Lines changed: 2 additions & 1 deletion b/‎CHANGELOG.rst‎
Lines changed: 2 additions & 1 deletion
diff --git a/‎MANIFEST.in‎
Lines changed: 12 additions & 2 deletions b/‎MANIFEST.in‎
Lines changed: 12 additions & 2 deletions
diff --git a/‎Makefile‎
Lines changed: 18 additions & 15 deletions b/‎Makefile‎
Lines changed: 18 additions & 15 deletions
diff --git a/‎README.rst‎
Lines changed: 9 additions & 15 deletions b/‎README.rst‎
Lines changed: 9 additions & 15 deletions
diff --git a/‎azure-pipelines.yml‎
Lines changed: 12 additions & 13 deletions b/‎azure-pipelines.yml‎
Lines changed: 12 additions & 13 deletions
diff --git a/‎clearcode/cdutils.py‎
Lines changed: 6 additions & 17 deletions b/‎clearcode/cdutils.py‎
Lines changed: 6 additions & 17 deletions
diff --git a/‎clearcode/management/commands/clearsync.py‎
Lines changed: 1 addition & 2 deletions b/‎clearcode/management/commands/clearsync.py‎
Lines changed: 1 addition & 2 deletions
@@ -21,23 +21,26 @@ on:
 jobs:
   build-pypi-distribs:
     name: Build and publish library to PyPI
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     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 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@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pypi_archives
           path: dist/*
@@ -47,17 +50,17 @@ jobs:
     name: Create GH release
     needs:
       - build-pypi-distribs
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     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/*
@@ -67,11 +70,11 @@ jobs:
     name: Create PyPI release
     needs:
       - create-gh-release
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Download built archives
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: pypi_archives
           path: dist
 
@@ -72,7 +72,6 @@ tcl
 # Ignore Jupyter Notebook related temp files
 .ipynb_checkpoints/
 
-# Env Files
+/.ruff_cache/
 .env
-
 var/
@@ -26,4 +26,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - dev
@@ -41,7 +41,8 @@ v5.0.0
 
 - Add `/api/docs` Swagger API documentation for API endpoints.
 - Add `/api/from_purl/purl2git` endpoint to get a git repo for a purl.
-- Add `/api/to_purl/go` endpoint to get a purl from a golang import string or a package string in go.mod.
+- Add `/api/to_purl/go` endpoint to get a purl from a golang import string or a
+  package string in go.mod.
 - Support indexing of PURLs listed in https://github.com/aboutcode-org/purldb/issues/326,
   https://github.com/aboutcode-org/purldb/issues/327, https://github.com/aboutcode-org/purldb/issues/328,
   https://github.com/aboutcode-org/purldb/issues/329 and https://github.com/aboutcode-org/purldb/issues/356.
 
@@ -4,17 +4,27 @@ graft matchcode
 graft minecode
 graft packagedb
 graft purldb
+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__ *.*~
@@ -48,8 +48,6 @@ conf:
 dev:
 	@echo "-> Configure and install development dependencies"
 	@PYTHON_EXECUTABLE=${PYTHON_EXE} ./configure --dev
-	@echo "-> Configure and install documentation dependencies"
-	@PYTHON_EXECUTABLE=${PYTHON_EXE} ./configure --docs
 
 envfile:
 	@echo "-> Create the .env file and generate a secret key"
@@ -63,17 +61,24 @@ envfile_testing: envfile
 	@echo SCANCODEIO_DB_USER=\"postgres\" >> ${ENV_FILE}
 	@echo SCANCODEIO_DB_PASSWORD=\"postgres\" >> ${ENV_FILE}
 
+doc8:
+	@echo "-> Run doc8 validation"
+	@${ACTIVATE} doc8 --quiet docs/ *.rst
+
 valid:
 	@echo "-> Run Ruff format"
-	@${ACTIVATE} ruff format  --exclude etc/scripts/ --exclude purldb-toolkit/ --exclude purl2vcs/
+	@${ACTIVATE} ruff format
 	@echo "-> Run Ruff linter"
-	@${ACTIVATE} ruff check --fix --exclude etc/scripts/ --exclude purldb-toolkit/ --exclude purl2vcs/
+	@${ACTIVATE} ruff check --fix
 
-check: check_docs
+check:
 	@echo "-> Run Ruff linter validation (pycodestyle, bandit, isort, and more)"
-	@${ACTIVATE} ruff check --exclude etc/scripts/ --exclude purldb-toolkit/ --exclude purl2vcs/
+	@${ACTIVATE} ruff check
 	@echo "-> Run Ruff format validation"
-	@${ACTIVATE} ruff format --check --exclude etc/scripts/ --exclude purldb-toolkit/ --exclude purl2vcs/
+	@${ACTIVATE} ruff format --check
+	@$(MAKE) doc8
+	@echo "-> Run ABOUT files validation"
+	@${ACTIVATE} about check etc/
 
 clean:
 	@echo "-> Clean the Python env"
@@ -106,7 +111,7 @@ postgres_matchcodeio:
 	@echo "-> Create 'matchcodeio' database"
 	${SUDO_POSTGRES} createdb --encoding=utf-8 --owner=matchcodeio matchcodeio
 	${MATCHCODE_MANAGE} migrate
-	
+
 run:
 	${MANAGE} runserver 8001 --insecure
 
@@ -123,7 +128,7 @@ run_map:
 	${MANAGE} run_map
 
 test_purldb:
-	${ACTIVATE} ${DJSM_PDB} pytest -vvs --lf minecode packagedb purl2vcs purldb_project purldb_public_project --ignore packagedb/tests/test_throttling.py 
+	${ACTIVATE} ${DJSM_PDB} pytest -vvs --lf minecode packagedb purl2vcs purldb_project purldb_public_project --ignore packagedb/tests/test_throttling.py
 	${ACTIVATE} ${DJSM_PDB} pytest -vvs --lf packagedb/tests/test_throttling.py
 
 test_toolkit:
@@ -160,11 +165,9 @@ docs:
 	rm -rf docs/_build/
 	@${ACTIVATE} sphinx-build docs/source docs/_build/
 
-check_docs:
-	@echo "Check Sphinx Documentation build minimally"
-	@${ACTIVATE} sphinx-build -E -W docs/source build
-	@echo "Check for documentation style errors"
-	@${ACTIVATE} doc8 --max-line-length 100 docs/source --ignore-path docs/_build/ --ignore D000 --quiet
+docs-check:
+	@${ACTIVATE} sphinx-build -E -W -b html docs/source docs/_build/
+	@${ACTIVATE} sphinx-build -E -W -b linkcheck docs/source docs/_build/
 
 docker-images:
 	@echo "-> Build Docker services"
@@ -176,4 +179,4 @@ docker-images:
 	@docker save minecode minecode_minecode nginx | gzip > dist/minecode-images-`git describe --tags`.tar.gz
 
 # keep this sorted
-.PHONY: black bump check check_docs clean `clearindex clearsync conf dev docker-images docs envfile envfile_testing index_packages isort migrate postgres postgres_matchcodeio priority_queue run run_map run_matchcodeio run_visit seed shell test test_clearcode test_matchcode test_purldb test_toolkit valid virtualenv
+.PHONY: bump check docs-check clean clearindex clearsync conf dev docker-images docs envfile envfile_testing index_packages migrate postgres postgres_matchcodeio priority_queue run run_map run_matchcodeio run_visit seed shell test test_clearcode test_matchcode test_purldb test_toolkit valid virtualenv
@@ -33,19 +33,19 @@ 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 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. 
+- nexB Inc.
 
 
 
-|europa|   |dgconnect| 
+|europa|   |dgconnect|
 
-|ngi|   |nlnet|   
+|ngi|   |nlnet|
 
 |aboutcode|  |nexb|
 
@@ -69,14 +69,14 @@ This project was funded through the NGI0 Commons Fund, a fund established by NLn
 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). 
+(SERI).
 
 |ngizerocommons| |swiss| https://nlnet.nl/project/FederatedCodeNext/
 
 
 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. 
+Communications Networks, Content and Technology under grant agreement No 101069594.
 
 |ngizeroentrust| https://nlnet.nl/project/Back2source/
 
@@ -90,7 +90,7 @@ Communications Networks, Content and Technology under grant agreement No 1010929
 
 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. 
+Communications Networks, Content and Technology under grant agreement No 101092990.
 
 |ngizerocore| https://nlnet.nl/project/FastScan/
 
@@ -120,14 +120,14 @@ Communications Networks, Content and Technology under grant agreement No 1010695
 
 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. 
+Communications Networks, Content and Technology under grant agreement No 101069594.
 
 |ngizeroentrust| https://nlnet.nl/project/purl2all/
 
 
 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. 
+Communications Networks, Content and Technology under grant agreement No 101069594.
 
 |ngizeroentrust| https://nlnet.nl/project/purl2sym/
 
@@ -196,9 +196,3 @@ Communications Networks, Content and Technology under grant agreement No 1010695
     :target: https://nlnet.nl/discovery/
     :height: 40
     :alt: NGI Discovery logo
-
-
-
-
-
-
@@ -16,35 +16,34 @@ resources:
         - 5432:5432
 
 jobs:
+    - template: etc/ci/azure-posix.yml
+      parameters:
+          job_name: ci_code_style
+          image_name: ubuntu-24.04
+          python_versions: ['3.12']
+          test_suites:
+              all: make check
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu20_cpython
-          image_name: ubuntu-20.04
+          image_name: ubuntu-22.04
           python_versions: ['3.10', '3.11', '3.12']
           test_suites:
               all: make test
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu22_cpython
-          image_name: ubuntu-22.04
+          image_name: ubuntu-24.04
           python_versions: ['3.10', '3.11', '3.12']
           test_suites:
               all: make test
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ci_documentation
-          image_name: ubuntu-22.04
-          python_versions: ['3.10']
+          image_name: ubuntu-24.04
+          python_versions: ['3.12']
           test_suites:
-              all: make docs check_docs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: ci_code_style
-          image_name: ubuntu-22.04
-          python_versions: ['3.10']
-          test_suites:
-              all: make check
+              all: make docs-check
@@ -185,9 +185,7 @@ def from_path(cls, pth, root=None):
         return cls(*segments)
 
     def to_api_path(self):
-        return "{type}/{provider}/{namespace}/{name}/{revision}".format(
-            **self.to_dict()
-        )
+        return "{type}/{provider}/{namespace}/{name}/{revision}".format(**self.to_dict())
 
     def to_def_blob_path(self):
         return "{type}/{provider}/{namespace}/{name}/revision/{revision}.json".format(
@@ -289,9 +287,7 @@ def from_purl(cls, purl):
 
         package_type = p.type
         if package_type not in PACKAGE_TYPES_BY_PURL_TYPE:
-            raise Exception(
-                f"Package type is not supported by ClearlyDefined: {package_type}"
-            )
+            raise Exception(f"Package type is not supported by ClearlyDefined: {package_type}")
         # Handle the source types of Maven and Debian packages
         if package_type == "maven" and p.qualifiers.get("classifier", "") == "sources":
             package_type = "sourcearchive"
@@ -330,9 +326,7 @@ def get_coordinates(data_dir):
             yield pth, Coordinate.from_path(cdpth)
 
 
-def _get_response_content(
-    url, retries=2, wait=2, session=requests, verbose=False, _retries=set()
-):
+def _get_response_content(url, retries=2, wait=2, session=requests, verbose=False, _retries=set()):
     """
     Return a tuple of (etag, md5, content bytes) with the content as bytes or as decoded
     text if `as_text` is True) of the response of a GET HTTP request at `url`.
@@ -379,9 +373,7 @@ def _get_response_content(
 
     # all other errors
     raise Exception(
-        "Failed HTTP request for {url} : error: {status_code} : {error_code}".format(
-            **locals()
-        )
+        "Failed HTTP request for {url} : error: {status_code} : {error_code}".format(**locals())
     )
 
 
@@ -427,12 +419,9 @@ def join_qs(keys_values, do_not_quote=()):
     Join a key/values mapping back into a query string.
     Quote values unless the name is in in the `do_not_quote` set.
     """
-    keys_values = {
-        k: (v[0] if v and isinstance(v, list) else v) for k, v in keys_values.items()
-    }
+    keys_values = {k: (v[0] if v and isinstance(v, list) else v) for k, v in keys_values.items()}
     return "&".join(
-        "=".join([k, v if k in do_not_quote else quote_plus(v)])
-        for k, v in keys_values.items()
+        "=".join([k, v if k in do_not_quote else quote_plus(v)]) for k, v in keys_values.items()
     )
 
 
 
@@ -58,8 +58,7 @@ def add_arguments(self, parser):
             dest="processes",
             default=1,
             type=int,
-            help="Set the number of parallel processes to use. "
-            "Disable parallel processing if 0.",
+            help="Set the number of parallel processes to use. Disable parallel processing if 0.",
         )
         parser.add_argument(
             "--max-def",