Merge pull request #73 from aboutcode-org/72-large-file-hash

Stream large files when computing hash #72

Author: AyanSinhaMahapatra

.github/workflows/docs-ci.yml

@@ -1,10 +1,10 @@
-name: CI Documentation
+name: CI Documentation and Code style
 
 on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       max-parallel: 4
@@ -20,11 +20,8 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Give permission to run scripts
-        run: chmod +x ./docs/scripts/doc8_style_check.sh
-
       - name: Install Dependencies
-        run:  pip install -e .[docs]
+        run:  pip install -e .[docs,testing]
 
       - name: Check Sphinx Documentation build minimally
         working-directory: ./docs
@@ -34,4 +31,5 @@ jobs:
         working-directory: ./docs
         run: ./scripts/doc8_style_check.sh
 
-
+      - name: Check for Code style errors
+        run: make check-ci

.github/workflows/pypi-release.yml

@@ -21,10 +21,10 @@ on:
 jobs:
   build-pypi-distribs:
     name: Build and publish library to PyPI
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
@@ -47,7 +47,7 @@ jobs:
     name: Create GH release
     needs:
       - build-pypi-distribs
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Download built archives
@@ -67,7 +67,7 @@ jobs:
     name: Create PyPI release
     needs:
       - create-gh-release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Download built archives

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Release notes
 =============
 
+
+Version 32.1.0 - (2024-12-06)
+-----------------------------
+
+- Compute file checksums from streaming the file content in chunks to avoid running out of memory
+
+
 Version 32.0.0 - (2024-09-05)
 -----------------------------
 

Makefile

@@ -4,7 +4,7 @@
 # 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/nexB/skeleton for support or download.
+# See https://github.com/aboutcode-org/skeleton for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
@@ -33,11 +33,19 @@ valid: isort black
 
 check:
 	@echo "-> Run pycodestyle (PEP8) validation"
-	@${ACTIVATE} pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,migrations,settings.py,.cache .
+	@${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 --check-only -l 100 setup.py src tests . 
+	@${ACTIVATE} isort --sl -l 100 src tests setup.py --check-only
 	@echo "-> Run black validation"
-	@${ACTIVATE} black --check --check -l 100 src tests setup.py
+	@${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
 
 clean:
 	@echo "-> Clean the Python env"

azure-pipelines.yml

@@ -13,47 +13,47 @@ jobs:
     parameters:
       job_name: ubuntu20_cpython
       image_name: ubuntu-20.04
-      python_versions: ["3.8", "3.9", "3.10", "3.11"]
+      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: ubuntu22_cpython
       image_name: ubuntu-22.04
-      python_versions: ["3.8", "3.9", "3.10", "3.11"]
+      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: macos12_cpython
       image_name: macOS-12
-      python_versions: ["3.8", "3.9", "3.10", "3.11"]
+      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
-      python_versions: ["3.8", "3.9", "3.10", "3.11"]
+      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.8", "3.9", "3.10", "3.11"]
+      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.8", "3.9", "3.10", "3.11"]
+      python_versions: ["3.9", "3.10", "3.11", "3.12"]
       test_suites:
         all: venv\Scripts\pytest -n 2 -vvs
 
@@ -63,9 +63,9 @@ jobs:
 
   - template: etc/ci/azure-posix.yml
     parameters:
-      job_name: ubuntu20_test_all_supported_click_versions
-      image_name: ubuntu-20.04
-      python_versions: ["3.8", "3.9", "3.10", "3.11"]
+      job_name: ubuntu22_test_all_supported_click_versions
+      image_name: ubuntu-22.04
+      python_versions: ["3.9", "3.10", "3.11", "3.12"]
       test_suites:
         click_versions: |
           for clk_ver in 8.1.3 8.1.2 8.1.1 8.1.0 8.0.4 8.0.2 8.0.3 8.0.1 7.1.2 7.1.1 7.1 6.7;
@@ -80,9 +80,9 @@ jobs:
 
   - template: etc/ci/azure-posix.yml
     parameters:
-      job_name: ubuntu20_cpython_latest_from_pip
-      image_name: ubuntu-20.04
-      python_versions: ["3.8", "3.9", "3.10", "3.11"]
+      job_name: ubuntu22_cpython_latest_from_pip
+      image_name: ubuntu-22.04
+      python_versions: ["3.9", "3.10", "3.11", "3.12"]
       test_suites:
         all: |
           venv/bin/pip install --upgrade-strategy eager --force-reinstall --upgrade -e .
@@ -93,7 +93,7 @@ jobs:
     parameters:
       job_name: win2019_cpython_latest_from_pip
       image_name: windows-2019
-      python_versions: ["3.8", "3.9", "3.10", "3.11"]
+      python_versions: ["3.9", "3.10", "3.11", "3.12"]
       test_suites:
         all: |
           venv\Scripts\pip install --upgrade-strategy eager --force-reinstall --upgrade -e .

docs/Makefile

@@ -5,6 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -14,6 +15,13 @@ help:
 
 .PHONY: help Makefile
 
+# Run the development server using sphinx-autobuild
+docs:
+	@echo
+	@echo "Starting up the docs server..."
+	@echo
+	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

docs/make.bat

@@ -7,11 +7,16 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
+if "%SPHINXAUTOBUILD%" == "" (
+	set SPHINXAUTOBUILD=sphinx-autobuild
+)
 set SOURCEDIR=source
 set BUILDDIR=build
 
 if "%1" == "" goto help
 
+if "%1" == "docs" goto docs
+
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -28,6 +33,13 @@ if errorlevel 9009 (
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
+:docs
+@echo
+@echo Starting up the docs server...
+@echo
+%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+goto end
+
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%