Merge pull request #2305 from nexB/release-3

Prepare Release 3.x

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.2.1.rc2
+current_version = 3.2.3
 files = setup.py src/scancode_config.py
 commit = False
 tag = False

CHANGELOG.rst

@@ -1,14 +1,22 @@
 Changelog
 =========
 
+v3.2.3 (2020-10-27)
+-------------------
+
+Notable changes:
+
+ - Collect Windows executable metadata #652
+ - Fix minor bugs
+ - Add Dockerfile to build docker image from ScanCode sources #2265
+
 
 v3.2.2rc3 (2020-09-21)
 ----------------------
 
-Internal code changes:
+Notable changes:
 
- - Ensure commoncode ccan become a standalone package #2233
- - Add Dockerfile to build docker image from ScanCode sources #2265
+ - Use commoncode, typecode and extractcode as external standalone packages #2233
 
 
 v3.2.1rc2 (2020-09-11)
@@ -94,8 +102,7 @@ v3.2.0rc1 (2020-09-08)
  - Improve runtime support for FreeBSD #1695  @knobix
  - Update macOS image on azure pipeline @TG1999
  - Improve documentation - @Vinay0001     
-
-
+
 
 v3.1.1 (2019-09-04)
 -------------------

README.rst

@@ -12,37 +12,43 @@ Why use ScanCode?
 =================
 
 - As a **standalone command-line tool**, ScanCode is **easy to install**, run,
-  and embed in your CI/CD processing pipeline. It runs on **Windows, macOS, and Linux**.
-
-- ScanCode is **used by several projects and organizations** such as the `Eclipse
-  Foundation <https://www.eclipse.org>`_, `OpenEmbedded.org <https://www.openembedded.org>`_,
-  the `FSF <https://www.fsf.org>`_, `OSS Review Toolkit <http://oss-review-toolkit.org>`_,
+  and embed in your CI/CD processing pipeline.
+  It runs on **Windows, macOS, and Linux**.
+
+- ScanCode is **used by several projects and organizations** such as
+  the `Eclipse Foundation <https://www.eclipse.org>`_,
+  `OpenEmbedded.org <https://www.openembedded.org>`_,
+  the `FSFE <https://www.fsfe.org>`_,
+  the `FSF <https://www.fsf.org>`_,
+  `OSS Review Toolkit <http://oss-review-toolkit.org>`_, 
   `ClearlyDefined.io <https://clearlydefined.io/>`_,
-  `RedHat Fabric8 analytics <https://github.com/fabric8-analytics>`_ and many more.
+  `RedHat Fabric8 analytics <https://github.com/fabric8-analytics>`_,
+  and many more.
 
-- ScanCode detects licenses, copyrights, package manifests, and direct dependencies
-  and more both in **source code** and **binary** files.
+- ScanCode detects licenses, copyrights, package manifests, direct
+  dependencies, and more both in **source code** and **binary** files.
 
 - ScanCode provides the **most accurate license detection engine** and does a
-  full comparison (also known as diff or red line comparison) between a database of license texts
-  and your code instead of relying only on regex patterns or probabilistic
-  search, edit distance, or machine learning.
+  full comparison (also known as diff or red line comparison) between a database
+  of license texts and your code instead of relying only on approximate regex
+  patterns or probabilistic search, edit distance or machine learning.
 
-- Written in Python, ScanCode is **easy to extend with plugins** to contribute new
-  and improved scanners, data summarization, package manifest parsers, and new
-  outputs.
+- Written in Python, ScanCode is **easy to extend with plugins** to contribute
+  new and improved scanners, data summarization, package manifest parsers, and
+  new outputs.
 
-- You can save your scan results as **JSON, HTML, CSV, or SPDX**. And you can use the
+- You can save your scan results as **JSON, HTML, CSV or SPDX**. And you can use the
   companion `ScanCode workbench GUI app <https://github.com/nexB/scancode-workbench>`_
-  to review and display scan results, statistics, and graphics.
+  to review and display scan results, statistics and graphics.
 
-- ScanCode is **actively maintained**, has a **growing community of users**.
+- ScanCode is **actively maintained**, has a **growing users and contributors
+  community**.
 
-- ScanCode is heavily **tested** with an automated test suite of over **8000 tests**.
+- ScanCode is heavily **tested** with an automated test suite of over **20,000 tests**.
 
-- ScanCode has extensive and updated Documentation help for users.
+See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_
+for upcoming features.
 
-See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_ for upcoming features.
 
 Build and tests status
 ======================
@@ -74,9 +80,16 @@ If you are new to Scancode, start `here <https://scancode-toolkit.readthedocs.io
 
 Other Important Documentation Pages:
 
-- A `Synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_ of ScanCode Command Line Options
-- Tutorials on `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_ and `How to Visualize Scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
-- An exhaustive List of `All Available Options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
+- A `synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_ 
+  of ScanCode command line options.
+
+- Tutorials on:
+
+  - `How to run a scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
+  - `How to visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
+
+- An exhaustive list of `all available options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
+
 - Documentation on `Contributing to Code Development <https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html>`_
 - Documentation on `Plugin Architecture <https://scancode-toolkit.readthedocs.io/en/latest/plugins/plugin_arch.html>`_
 - `FAQ <https://scancode-toolkit.readthedocs.io/en/latest/misc/faq.html>`_
@@ -87,50 +100,71 @@ See also https://aboutcode.org for related companion projects and tools.
 Installation
 ============
 
-Before installing ScanCode make sure you've installed the prerequisites properly. This mainly
-refers to installing the required Python interpreter (Python 3.6 is recommended). Refer
-`Prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_ for detailed information on all different platforms and Python Versions.
+Before installing ScanCode make sure that you have installed the prerequisites
+properly. This means installing Python (Python 3.6 is required in most cases).
+See `prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_
+for detailed information on the support platforms and Python versions.
+
+There are a few common ways to `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
+
+- `*Recommended* installation as an application: Download a release archive, extract and run.
+  <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_
+
+- `Development installation from source code: git clone 
+  <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-from-source-code-git-clone>`_
+
+- `Development installation as a library: via pip install scancode-toolkit[full] 
+  <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
+
+- `Run as a Docker container: git clone and docker run
+  <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_
 
-There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
 
-- `Installation as an Application: Downloading Releases <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_ *(Recommended)*
-- `Installation via Docker: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_
-- `Installation from Source Code: Git Clone <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-from-source-code-git-clone>`_
-- `Installation as a library: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
 
 Quick Start
 ===========
 
-Note the `Commands Variation <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#commands-variation>`_ across Installation methods and Platforms.
+Note the `commands variation <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#commands-variation>`_
+across installation methods and platforms.
 
 You can run an example scan printed on screen as JSON::
 
     ./scancode -clip --json-pp - samples
 
-Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_ Tutorial
-to perform a basic scan on the ``samples`` directory distributed by default with Scancode.
+Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
+tutorial to perform a basic scan on the ``samples`` directory distributed by
+default with Scancode.
 
 See more command examples::
 
     ./scancode --examples
 
-Refer `How to set what will be detected in Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
-and `How to specify Scancode Output Format <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_format_scan_output.html>`_ for more information.
+See `How to select what will be detected in a scan
+<https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
+and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_format_scan_output.html>`_
+for more information.
+
+You can also refer to the `command line options synopsis
+<https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_
+and an exhaustive list of `all available options
+<https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_.
 
-You can also refer to `Command Line Options Synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_ and an exhaustive List of `All Available Options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_.
 
 Archive extraction
 ==================
 
-The archives that exist in a codebase must be extracted before running a scan:
-ScanCode does not extract files from tarballs, zip files, etc. as part of the
-scan. The bundled utility `extractcode` is a mostly-universal archive extractor.
-For example, this command will recursively extract the mytar.tar.bz2 tarball in
-the mytar.tar.bz2-extract directory::
+ScanCode does not extract by default files from tarballs, zip files, and
+other archives as part of the scan. The archives that exist in a codebase
+must be extracted before running a scan: the bundled utility `extractcode`
+is a mostly-universal archive extractor. For example, this command will
+recursively extract the mytar.tar.bz2 tarball in the mytar.tar.bz2-extract
+directory::
 
     ./extractcode mytar.tar.bz2
 
-Refer `All Extractcode Options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_ and `How To Extract Archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for more information.
+See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_
+and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
+
 
 Support
 =======
@@ -140,21 +174,22 @@ https://github.com/nexB/scancode-toolkit/issues
 
 For discussions and chats, we have:
 
-* an official Gitter channel for web-based chats at https://gitter.im/aboutcode-org/discuss
-  Gitter is also accessible via an IRC bridge at https://irc.gitter.im/
+* an official Gitter channel for `web-based chats
+  <https://gitter.im/aboutcode-org/discuss>`_.
+  Gitter is also accessible via an `IRC bridge <https://irc.gitter.im/>`_.
+  There are other AboutCode project-specific channels available there too.
 
 * an official `#aboutcode` IRC channel on freenode (server chat.freenode.net).
-  This channel receives build and commit notifications and can be a tad noisy.
-  You can use your favorite IRC client or use the web chat at
-  https://webchat.freenode.net/
+  This channel receives build and commit notifications and can be noisy.
+  You can use your favorite IRC client or use the `web chat 
+  <https://webchat.freenode.net/>`_.
 
-* a Gitter channel to discuss Documentation at https://gitter.im/aboutcode-org/gsod-season-of-docs
 
 Source code and downloads
 =========================
 
-* https://github.com/nexB/scancode-toolkit.git
 * 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
 

setup.py

@@ -15,7 +15,7 @@
 from setuptools import find_packages
 from setuptools import setup
 
-version = '3.2.2.rc3'
+version = '3.2.3'
 
 #### Small hack to force using a plain version number if the option
 #### --plain-version is passed to setup.py

src/scancode_config.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2018 nexB Inc. and others. All rights reserved.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # http://nexb.com and https://github.com/nexB/scancode-toolkit/
 # The ScanCode software is licensed under the Apache License version 2.0.
 # Data generated with ScanCode require an acknowledgment.
@@ -97,7 +97,7 @@ def _create_dir(location):
     __version__ = get_distribution('scancode-toolkit').version
 except DistributionNotFound:
     # package is not installed ??
-    __version__ = '3.2.1.rc2'
+    __version__ = '3.2.3'
 
 system_temp_dir = tempfile.gettempdir()
 scancode_src_dir = dirname(__file__)