Add a new console script to build the package patterns cache

Signed-off-by: Ayan Sinha Mahapatra <asmahapatra@aboutcode.org>

Author: AyanSinhaMahapatra

Dockerfile

@@ -38,9 +38,11 @@ WORKDIR /scancode-toolkit
 COPY . /scancode-toolkit
 
 # Initial configuration using ./configure, scancode-reindex-licenses to build
-# the base license index
+# the base license index and scancode-cache-package-patterns to build the 
+# package patterns cache
 RUN ./configure \
- && ./venv/bin/scancode-reindex-licenses
+ && ./venv/bin/scancode-reindex-licenses \
+ && ./venv/bin/scancode-cache-package-patterns
 
 # Add scancode to path
 ENV PATH=/scancode-toolkit:$PATH

etc/release/scancode-create-pypi-wheel.sh

@@ -19,6 +19,7 @@ set -e
 
 ./configure --dev
 venv/bin/scancode-reindex-licenses
+venv/bin/scancode-cache-package-patterns
 
 python_tag=$( python -c "import platform;print(f\"cp{''.join(platform.python_version_tuple()[:2])}\")" )
 

etc/release/scancode-create-release-app-linux.sh

@@ -65,6 +65,7 @@ cp -r etc/thirdparty $release_dir/etc
 # Build the wheel
 ./configure --dev
 venv/bin/scancode-reindex-licenses
+venv/bin/scancode-cache-package-patterns
 venv/bin/python setup.py --quiet bdist_wheel --python-tag cp$python_version
 
 cp -r \

etc/release/scancode-create-release-app-macos.sh

@@ -63,6 +63,7 @@ cp -r etc/thirdparty $release_dir/etc
 # Build the wheel
 ./configure --dev
 venv/bin/scancode-reindex-licenses
+venv/bin/scancode-cache-package-patterns
 venv/bin/python setup.py --quiet bdist_wheel --python-tag cp$python_version
 
 cp -r \

etc/release/scancode-create-release-app-windows.sh

@@ -62,6 +62,7 @@ cp -r etc/thirdparty $release_dir/etc
 # Build the wheel
 ./configure --dev
 venv/bin/scancode-reindex-licenses
+venv/bin/scancode-cache-package-patterns
 venv/bin/python setup.py --quiet bdist_wheel --python-tag cp$python_version
 
 cp -r \

setup-mini.cfg

@@ -157,6 +157,7 @@ packages =
 console_scripts =
     scancode = scancode.cli:scancode
     scancode-reindex-licenses = licensedcode.reindex:reindex_licenses
+    scancode-cache-package-patterns = packagedcode.cache:cache_package_patterns
     scancode-license-data = licensedcode.license_db:dump_scancode_license_data
     regen-package-docs = packagedcode.regen_package_docs:regen_package_docs
     add-required-phrases = licensedcode.required_phrases:add_required_phrases

setup.cfg

@@ -159,6 +159,7 @@ packages =
 console_scripts =
     scancode = scancode.cli:scancode
     scancode-reindex-licenses = licensedcode.reindex:reindex_licenses
+    scancode-cache-package-patterns = packagedcode.cache:cache_package_patterns
     scancode-license-data = licensedcode.license_db:dump_scancode_license_data
     regen-package-docs = packagedcode.regen_package_docs:regen_package_docs
     add-required-phrases = licensedcode.required_phrases:add_required_phrases

src/packagedcode/cache.py

@@ -13,7 +13,9 @@
 import multiregex
 
 import attr
+import click
 
+from commoncode.cliutils import PluggableCommandLineOption
 from commoncode.fileutils import create_dir
 from packagedcode import APPLICATION_PACKAGE_DATAFILE_HANDLERS
 from packagedcode import SYSTEM_PACKAGE_DATAFILE_HANDLERS
@@ -219,3 +221,16 @@ def load_cache_file(cache_file):
                 'and submit a bug report at https://github.com/nexB/scancode-toolkit/issues/'
             )
             raise Exception(msg) from e
+
+
+@click.command(name='scancode-cache-package-patterns')
+@click.help_option('-h', '--help')
+def cache_package_patterns(*args, **kwargs):
+    """Create scancode package manifest patterns cache and exit"""
+    click.echo('Rebuilding the package cache patterns...')
+    get_cache(force=True)
+    click.echo('Done.')
+
+
+if __name__ == '__main__':
+    cache_package_patterns()