Improve documented versions in the license dump

* Add a better version in scancode-config, using git describe
* Add SPDX license list version to the HTML footer

Reference: #3200
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: pombredanne

src/licensedcode/license_db.py

@@ -1,27 +1,11 @@
-# SPDX-License-Identifier: CC-BY-4.0 AND Apache-2.0
 #
-# https://github.com/nexB/scancode-licensedb
-# Copyright 2020 nexB Inc. and others.
+# 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/nexB/scancode-toolkit for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 #
-# ScanCode LicenseDB data is licensed under the Creative Commons Attribution
-# License 4.0 (CC-BY-4.0).
-# Some licenses, such as the GNU GENERAL PUBLIC LICENSE, are subject to other licenses.
-# See the corresponding license text for the specific license conditions.
-#
-# ScanCode LicenseDB software is licensed under the Apache License version 2.0.
-# You may not use this software except in compliance with the License.
-# You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
-# Unless required by applicable law or agreed to in writing, software distributed
-# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-# CONDITIONS OF ANY KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations under the License.
-#
-# ScanCode LicenseDB is generated with ScanCode Toolkit. The database and its contents
-# are provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
-# either express or implied.
-# No content from ScanCode LicenseDB should be considered or used as legal advice.
-# Consult an attorney for any legal advice.
 
 import os
 import json
@@ -40,7 +24,7 @@
 from licensedcode.models import load_licenses
 from licensedcode.models import licenses_data_dir
 from scancode_config import __version__ as scancode_version
-
+from scancode_config import spdx_license_list_version
 
 TEMPLATES_DIR = os.path.join(dirname(__file__), 'templates')
 STATIC_DIR = os.path.join(dirname(__file__), 'static')
@@ -51,18 +35,19 @@ def write_file(path, filename, content):
 
 
 def now():
-    return datetime.now().strftime("%b %d, %Y")
-
+    return datetime.utcnow().strftime('%Y-%m-%dT')
 
 base_context = {
     "scancode_version": scancode_version,
     "now": now(),
+    "spdx_license_list_version": spdx_license_list_version,
 }
 
 
 base_context_test = {
     "scancode_version": "32.0.0b1",
     "now": "Dec 22, 2022",
+    "spdx_license_list_version": "3.19",
 }
 
 

src/licensedcode/templates/footer.html

@@ -6,8 +6,11 @@
       <a href="https://github.com/nexB/scancode-licensedb" target="_blank">GitHub</a> ·
       <a href="https://www.aboutcode.org/" target="_blank">AboutCode</a>
     </p>
-    <p>Designed and built by <a href="https://www.nexb.com/" target="_blank">nexB</a>. Licensed under the <a href="cc-by-4.0.html">Creative Commons Attribution License 4.0 (CC-BY-4.0)</a>.</p>
-    <p>Generated with <a href="https://github.com/nexB/scancode-toolkit" target="_blank">ScanCode toolkit</a> {{ scancode_version }} on {{ now }}.</p>
-    <p>This is updated daily automatically with latest updates from the develop branch of scancode-toolkit, if any.</p>
+    <p>Designed and built by <a href="https://www.nexb.com/" target="_blank">nexB</a>.
+    Licensed under the <a href="cc-by-4.0.html">Creative Commons Attribution License 4.0 (CC-BY-4.0)</a>.</p>
+    <p>Generated with <a href="https://github.com/nexB/scancode-toolkit" target="_blank">ScanCode toolkit</a>
+    {{ scancode_version }} on {{ now }}.</p>
+    <p>SPDX Licenses list version: {{ spdx_license_list_version }}</p>
+    
   </footer>
 </div>

src/scancode_config.py

@@ -70,43 +70,80 @@ def _create_dir(location):
 ################################################################################
 # INVARIABLE INSTALLATION-SPECIFIC, BUILT-IN LOCATIONS AND FLAGS
 ################################################################################
-# these are guaranteed to be there and are entirely based on and relative to the
+# These are guaranteed to be there and are entirely based on and relative to the
 # current installation location. This is where the source code and static data
 # lives.
 
 
-# in case package is not installed or we do not have setutools/pkg_resources
-# on hand fall back to this version
-__version__ = '32.0.0rc1'
+system_temp_dir = tempfile.gettempdir()
+scancode_src_dir = dirname(__file__)
+scancode_root_dir = dirname(scancode_src_dir)
 
-# used to warn user when the version is out of date
-__release_date__ = datetime.datetime(2023, 1, 3)
+# USAGE MODE FLAG. If we have a .git dir, we are a git clone and developing
+_SCANCODE_DEV_MODE = os.path.exists(join(scancode_root_dir, '.git'))
 
-# See https://github.com/nexB/scancode-toolkit/issues/2653 for more information
-# on the data format version
-__output_format_version__ = '3.0.0'
+# There are multiple cases for versions, depending on where we come from:
+__version__ = ''
 
-#
-spdx_license_list_version = '3.19'
+# 1. - a git clone: we can use git describe which take consider the closest tag
+#   "git describe --dirty > SCANCODE_VERSION"
+# This is the common case when we develop, including dump the latestlicense db
+if _SCANCODE_DEV_MODE:
 
-try:
-    from pkg_resources import get_distribution, DistributionNotFound
+    from subprocess import check_output
+    from subprocess import STDOUT
+    from subprocess import CalledProcessError
+
+    # this may fail with exceptions
+    cmd = 'git', 'describe',
     try:
-        __version__ = get_distribution('scancode-toolkit').version
-    except DistributionNotFound:
+        output = check_output(cmd, stderr=STDOUT)
+        __version__ = output.decode('utf-8').strip()
+    except (Exception, CalledProcessError) as e:
         pass
-except ImportError:
-    pass
 
-system_temp_dir = tempfile.gettempdir()
-scancode_src_dir = dirname(__file__)
-scancode_root_dir = dirname(scancode_src_dir)
+# 2. - the scancode-tool binary or sources app archives: with a SCANCODE_VERSION
+#   file containing the git tag of the release with "git describe --tags > SCANCODE_VERSION"
+# - a tarball without an updated .VERSION, we cannot tell anything and we will use importlib metadata
+# - a wheel or sdist in which case we use the importlib metadata
+# we use importlib metadata in all these cases
+if not __version__:
+    try:
+        from importlib_metadata import version
+        __version__ = version('scancode-toolkit')
+    except Exception:
+        pass
 
-################################################################################
-# USAGE MODE FLAGS
-################################################################################
+# 3. - a tarball or zip archive from git with a .VERSION file with var substitution:
+#   .VERSION will contain:
+#      refs=HEAD -> fix-license-dump
+#      commit=5ccc92e69cffb503e9bedc7fce5a1dbb0fd851da
+#      abbrev_commit=5ccc92e69c
+#      committer_date=2023-01-16
+#      git_describe=v31.2.3-328-g5ccc92e69c
+#    otherwise it contains:
+#      refs=$Format:%D$
+#      commit=$Format:%H$
+#      abbrev_commit=$Format:%h$
+#      committer_date=$Format:%cs$
+#      git_describe=$Format:%(describe)$
+# NOTE: we do not handle this for now
+
+# 4. hardcoded This is the default, fallback version in case package is not installed or we
+# do not have a proper version otherwise.
+if not __version__:
+    __version__ = '32.0.0rc1'
+
+#######################
+# used to warn user when the version is out of date
+__release_date__ = datetime.datetime(2023, 1, 15)
 
-_SCANCODE_DEV_MODE = os.path.exists(join(scancode_root_dir, '.git'))
+# See https://github.com/nexB/scancode-toolkit/issues/2653 for more information
+# on the data format version
+__output_format_version__ = '3.0.0'
+
+#
+spdx_license_list_version = '3.19'
 
 ################################################################################
 # USAGE MODE-, INSTALLATION- and IMPORT- and RUN-SPECIFIC DIRECTORIES
@@ -171,6 +208,5 @@ def _create_dir(location):
 _prefix = 'scancode-tk-' + __version__ + '-'
 scancode_temp_dir = tempfile.mkdtemp(prefix=_prefix, dir=__scancode_temp_base_dir)
 
-
 # Used for tests to regenerate fixtures with regen=True
 REGEN_TEST_FIXTURES = os.getenv('SCANCODE_REGEN_TEST_FIXTURES', False)