From 49790e82937cfface7794af722bec6c4147704cb Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Tue, 16 Dec 2025 11:51:57 -0800 Subject: [PATCH 01/16] Update README.rst with restructured content --- README.rst | 191 ++++++++++++++++------------------------------------- 1 file changed, 57 insertions(+), 134 deletions(-) diff --git a/README.rst b/README.rst index ddc164e1fc8..077d9af9b43 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,52 @@ -================ -ScanCode toolkit -================ +# ScanCode Toolkit -A typical software project often reuses hundreds of third-party packages. -License and packages, dependencies and origin information is not always easy to -find and not normalized: ScanCode discovers and normalizes this data for you. +ScanCode Toolkit is a set of code scanning tools that detect the origin (copyrights), license and vulnerabilities of code, packages and dependencies in a codebase. -Read more about ScanCode here: https://scancode-toolkit.readthedocs.io/. +## Getting Started -Check out the code at https://github.com/nexB/scancode-toolkit +These instructions will get you a copy of the project up and running on your local machine. -Discover also: +https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html + +These instructions will guide you to start scanning code. + +https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/synopsis.html#synopsis-quickstart + +### Prerequisites + +What things you need to install the software and how to install them. + +https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#before-installing + +### Exploring ScanCode Features + +Discover the ScanCode command line options that meet your requirements. + +https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/index.html + +## Guided Tours + +These tutorials will provide hands-on guidance to ScanCode features. + +https://scancode-toolkit.readthedocs.io/en/stable/tutorials/index.html + +### Advanced Topics + +Expand the ScanCode Licenses and Detection Rules with your own data. + +https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/index.html + +Generate Attribution from a ScanCode scan. + +https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/generate_attribution.html + +## Contributing + +Guidelines for contributing to code development. + +https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html# + +## Discover also: - The ScanCode.io server project here: https://scancodeio.readthedocs.io - The ScanCode Workbench project for visualization of scancode results data: @@ -18,9 +54,7 @@ Discover also: - Other companion SCA projects for code origin, license and security analysis here: https://aboutcode.org - -Build and tests status -====================== +## Build and tests status We run 30,000+ tests on each commit on multiple CIs to ensure a good platform compabitility with multiple versions of Windows, Linux and macOS. @@ -31,9 +65,7 @@ compabitility with multiple versions of Windows, Linux and macOS. | |azure| | |docs-rtd| | |docs-github-actions| | |release-github-actions| | +------------+--------------+-------------------------+----------------------------+ - -Why use ScanCode? -================= +## Why use ScanCode? - As a **standalone command-line tool**, ScanCode is **easy to install**, run, and embed in your CI/CD processing pipeline. @@ -100,117 +132,12 @@ Why use ScanCode? See our `roadmap `_ for upcoming features. +See also https://github.com/aboutcode-org/aboutcode?tab=readme-ov-file#aboutcode for related companion projects and tools. -Documentation -============= - -The ScanCode documentation is hosted at -`scancode-toolkit.readthedocs.io `_. - -If you are new to visualization of scancode results data, start with our -`newcomer `_ page. - -If you want to compare output changes between different versions of ScanCode, -or want to look at scans generated by ScanCode, review our -`reference scans `_. - -Other Important Documentation Pages: - -- A `synopsis `_ - of ScanCode command line options. - -- Tutorials on: - - - `How to run a scan `_ - - `How to visualize scan results `_ - -- An exhaustive list of `all available options `_ - -- Documentation on `Contributing to Code Development `_ - -- Documentation on `Plugin Architecture `_ - -- `FAQ `_ - -See also https://aboutcode.org for related companion projects and tools. - - -Installation -============ - -Before installing ScanCode make sure that you have installed the prerequisites -properly. This means installing Python 3.13 for x86/64 architectures. -We support Python 3.10, 3.11, 3.12 and 3.13. - -See `prerequisites `_ -for detailed information on the support platforms and Python versions. - -There are a few common ways to `install ScanCode `_. - -- `**Installation as an application: Install Python 3.13, download a release archive, extract and run**. - `_ - This is the recommended installation method. - -- `Development installation from source code using a git clone - `_ - -- `Development installation as a library with "pip install scancode-toolkit" - `_ - [Note that this is not supported on arm64 machines] - -- `Run in a Docker container with a git clone and "docker run" - `_ - -- In Fedora 40+ you can `dnf install scancode-toolkit` - - -Quick Start -=========== - -After ScanCode is installed successfully you can run an example scan printed on screen as JSON:: - - scancode -clip --json-pp - samples - -Follow the `How to Run a Scan `_ -tutorial to perform a basic scan on the ``samples`` directory distributed by -default with ScanCode. - -See more command examples:: - - scancode --examples - -See `How to select what will be detected in a scan -`_ -and `How to specify the output format `_ -for more information. - -You can also refer to the `command line options synopsis -`_ -and an exhaustive list of `all available command line options -`_. - - -Archive extraction -================== - -By default ScanCode does not extract 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: `extractcode` is a bundled utility -behaving as 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 - -See `all extractcode options `_ -and `how to extract archives `_ for details. - - -Support -======= +## Support If you have a problem, a suggestion or found a bug, please enter a ticket at: -https://github.com/nexB/scancode-toolkit/issues +https://github.com/aboutcode-org/scancode-toolkit/issues For discussions and chats, we have: @@ -223,8 +150,7 @@ For discussions and chats, we have: * The discussion channel for `scancode `_ specifically aimed at users and developers using scancode-toolkit. -Source code and downloads -========================= +## Source code and downloads * https://github.com/aboutcode-org/scancode-toolkit/releases * https://github.com/aboutcode-org/scancode-toolkit.git @@ -233,19 +159,17 @@ Source code and downloads * https://github.com/aboutcode-org/scancode-plugins.git * https://github.com/aboutcode-org/thirdparty-packages.git -License -======= +## License -* Apache-2.0 as the overall license -* CC-BY-4.0 for reference datasets (initially was in the Public Domain). +* Apache-2.0 is the overall license +* CC-BY-4.0 applies to reference datasets. * Multiple other secondary permissive or copyleft licenses (LGPL, MIT, BSD, GPL 2/3, etc.) for third-party components and test suite code and data. - See the NOTICE file and the .ABOUT files that document the origin and license of the third-party code used in ScanCode for more details. - +## Status of Tests .. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop @@ -263,9 +187,7 @@ the third-party code used in ScanCode for more details. :target: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml :alt: Release tests - -Acknowledgements, Funding, Support and Sponsoring --------------------------------------------------------- +## Acknowledgements, Funding, Support and Sponsoring This project is funded, supported and sponsored by: @@ -394,3 +316,4 @@ Communications Networks, Content and Technology under grant agreement No 1010695 :target: https://nlnet.nl/discovery/ :height: 40 :alt: NGI Discovery logo + From 854424c8537e931050dc254e842ed5c2924b58e1 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Tue, 16 Dec 2025 11:54:53 -0800 Subject: [PATCH 02/16] Rename README.rst to README.md --- README.rst => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.rst => README.md (100%) diff --git a/README.rst b/README.md similarity index 100% rename from README.rst rename to README.md From 8d4bb748c61e678ac3779a4d8598df5f9a5097b0 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Tue, 16 Dec 2025 13:28:22 -0800 Subject: [PATCH 03/16] Update README.md Why text --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 077d9af9b43..63aa5f1241d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ ScanCode Toolkit is a set of code scanning tools that detect the origin (copyrights), license and vulnerabilities of code, packages and dependencies in a codebase. +## Why + +ScanCode Toolkit is the leading tool in scanning depth and accuracy, used by hundreds of software teams. You can use ScanCode Toolkit as a command line tool or as a library. + ## Getting Started These instructions will get you a copy of the project up and running on your local machine. @@ -65,7 +69,7 @@ compabitility with multiple versions of Windows, Linux and macOS. | |azure| | |docs-rtd| | |docs-github-actions| | |release-github-actions| | +------------+--------------+-------------------------+----------------------------+ -## Why use ScanCode? +## Benefits of ScanCode? - As a **standalone command-line tool**, ScanCode is **easy to install**, run, and embed in your CI/CD processing pipeline. From 72194841464e8273c999dab958e9bacf85885f8e Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Tue, 16 Dec 2025 13:30:52 -0800 Subject: [PATCH 04/16] Update README.md to reduce excess details --- README.md | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 63aa5f1241d..21594fd4ef2 100644 --- a/README.md +++ b/README.md @@ -117,20 +117,8 @@ compabitility with multiple versions of Windows, Linux and macOS. - ScanCode has an extensive and growing documentation. - ScanCode can process packages, build manifest and lockfile formats to collect - Package URLs and extract metadata: Alpine packages, BUCK files, ABOUT files, - Android apps, Autotools, Bazel, JavaScript Bower, Java Axis, MS Cab, - Rust Cargo, Cocoapods, Chef Chrome apps, PHP Composer and composer.lock, - Conda, CPAN, Debian, Apple dmg, Java EAR, WAR, JAR, FreeBSD packages, - Rubygems gemspec, Gemfile and Gemfile.lock, Go modules, Haxe packages, - InstallShield installers, iOS apps, ISO images, Apache IVY, JBoss Sar, - R CRAN, Apache Maven, Meteor, Mozilla extensions, MSI installers, - JavaScript npm packages, package-lock.json, yarn.lock, NSIS Installers, - NuGet, OPam, Cocoapods, Python PyPI setup.py, setup.cfg, and - several related lockfile formats, semi structured README - files such as README.android, README.chromium, README.facebook, README.google, - README.thirdparty, RPMs, Shell Archives, Squashfs images, Java WAR, Windows - executables and the Windows registry - and a few more. See `all available package parsers `_ + Package URLs and extract metadata. See all available package parsers + `_ for the exhaustive list. See our `roadmap `_ From 9c6ef39ed1159616bc9d43d7a27a5836f1b15033 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 11:01:41 -0800 Subject: [PATCH 05/16] Update README.md to restore RST syntax --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 49 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 21594fd4ef2..348b4058c61 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ -# ScanCode Toolkit +================ +ScanCode Toolkit +================ ScanCode Toolkit is a set of code scanning tools that detect the origin (copyrights), license and vulnerabilities of code, packages and dependencies in a codebase. -## Why +Why Use ScanCode Toolkit? +========================= ScanCode Toolkit is the leading tool in scanning depth and accuracy, used by hundreds of software teams. You can use ScanCode Toolkit as a command line tool or as a library. -## Getting Started +Getting Started +=============== These instructions will get you a copy of the project up and running on your local machine. @@ -16,25 +20,29 @@ These instructions will guide you to start scanning code. https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/synopsis.html#synopsis-quickstart -### Prerequisites +Prerequisites +============= What things you need to install the software and how to install them. https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#before-installing -### Exploring ScanCode Features +Exploring ScanCode Features +=========================== Discover the ScanCode command line options that meet your requirements. https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/index.html -## Guided Tours +Guided Tours +============ These tutorials will provide hands-on guidance to ScanCode features. https://scancode-toolkit.readthedocs.io/en/stable/tutorials/index.html -### Advanced Topics +Advanced Topics +=============== Expand the ScanCode Licenses and Detection Rules with your own data. @@ -44,13 +52,15 @@ Generate Attribution from a ScanCode scan. https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/generate_attribution.html -## Contributing +Contributing +============ Guidelines for contributing to code development. https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html# -## Discover also: +Discover also: +============== - The ScanCode.io server project here: https://scancodeio.readthedocs.io - The ScanCode Workbench project for visualization of scancode results data: @@ -58,7 +68,23 @@ https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html# - Other companion SCA projects for code origin, license and security analysis here: https://aboutcode.org -## Build and tests status +Archive extraction +================== + +By default ScanCode does not extract 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: `extractcode` is a bundled utility +behaving as 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 + +See `all extractcode options `_ +and `how to extract archives `_ for details. + +Build and tests status +====================== We run 30,000+ tests on each commit on multiple CIs to ensure a good platform compabitility with multiple versions of Windows, Linux and macOS. @@ -69,7 +95,8 @@ compabitility with multiple versions of Windows, Linux and macOS. | |azure| | |docs-rtd| | |docs-github-actions| | |release-github-actions| | +------------+--------------+-------------------------+----------------------------+ -## Benefits of ScanCode? +Benefits of ScanCode +==================== - As a **standalone command-line tool**, ScanCode is **easy to install**, run, and embed in your CI/CD processing pipeline. @@ -126,7 +153,8 @@ for upcoming features. See also https://github.com/aboutcode-org/aboutcode?tab=readme-ov-file#aboutcode for related companion projects and tools. -## Support +Support +======= If you have a problem, a suggestion or found a bug, please enter a ticket at: https://github.com/aboutcode-org/scancode-toolkit/issues @@ -142,7 +170,8 @@ For discussions and chats, we have: * The discussion channel for `scancode `_ specifically aimed at users and developers using scancode-toolkit. -## Source code and downloads +Source code and downloads +========================= * https://github.com/aboutcode-org/scancode-toolkit/releases * https://github.com/aboutcode-org/scancode-toolkit.git @@ -151,7 +180,8 @@ For discussions and chats, we have: * https://github.com/aboutcode-org/scancode-plugins.git * https://github.com/aboutcode-org/thirdparty-packages.git -## License +License +======= * Apache-2.0 is the overall license * CC-BY-4.0 applies to reference datasets. @@ -161,7 +191,8 @@ For discussions and chats, we have: See the NOTICE file and the .ABOUT files that document the origin and license of the third-party code used in ScanCode for more details. -## Status of Tests +Status of Tests +=============== .. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop @@ -179,7 +210,8 @@ the third-party code used in ScanCode for more details. :target: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml :alt: Release tests -## Acknowledgements, Funding, Support and Sponsoring +Acknowledgements, Funding, Support and Sponsoring +================================================= This project is funded, supported and sponsored by: @@ -309,3 +341,4 @@ Communications Networks, Content and Technology under grant agreement No 1010695 :height: 40 :alt: NGI Discovery logo +**End of ScanCode Toolkit README** From 7ff864ab431aa27e614a62320d00be16329666e2 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 11:05:41 -0800 Subject: [PATCH 06/16] Rename README.md to README.rst --- README.md => README.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.md => README.rst (100%) diff --git a/README.md b/README.rst similarity index 100% rename from README.md rename to README.rst From af82ee8d1afdc6f16670c5dee668e84e125616be Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 11:09:07 -0800 Subject: [PATCH 07/16] Update README.rst to correct syntax --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 348b4058c61..dbb05ee2003 100644 --- a/README.rst +++ b/README.rst @@ -191,8 +191,7 @@ License See the NOTICE file and the .ABOUT files that document the origin and license of the third-party code used in ScanCode for more details. -Status of Tests -=============== + .. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop @@ -210,6 +209,7 @@ Status of Tests :target: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml :alt: Release tests + Acknowledgements, Funding, Support and Sponsoring ================================================= From 7809eacb206da88362dc5734175dd441f56b83af Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 11:35:59 -0800 Subject: [PATCH 08/16] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index dbb05ee2003..5988fb1f795 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ ScanCode Toolkit ================ -ScanCode Toolkit is a set of code scanning tools that detect the origin (copyrights), license and vulnerabilities of code, packages and dependencies in a codebase. +ScanCode Toolkit is a set of code scanning tools that detect the origin (copyrights), license and vulnerabilities of code, packages and dependencies in a codebase. ScanCode Toolkit is an `AboutCode project `_. Why Use ScanCode Toolkit? ========================= From a573e477fcaf4487a08208a4880b881e70fa5b44 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 11:57:42 -0800 Subject: [PATCH 09/16] Update README.rst syntax --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 5988fb1f795..3db83b22dad 100644 --- a/README.rst +++ b/README.rst @@ -57,7 +57,7 @@ Contributing Guidelines for contributing to code development. -https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html# +https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html Discover also: ============== From 0d8806430a824b416eba0c6214c81a6fc00c6657 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 11:59:12 -0800 Subject: [PATCH 10/16] Update README.rst to remove unnecessary text --- README.rst | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/README.rst b/README.rst index 3db83b22dad..a21563099a3 100644 --- a/README.rst +++ b/README.rst @@ -68,21 +68,6 @@ Discover also: - Other companion SCA projects for code origin, license and security analysis here: https://aboutcode.org -Archive extraction -================== - -By default ScanCode does not extract 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: `extractcode` is a bundled utility -behaving as 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 - -See `all extractcode options `_ -and `how to extract archives `_ for details. - Build and tests status ====================== From 63370f1b334160f4dac7afa62f28954d19f84e23 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 12:01:41 -0800 Subject: [PATCH 11/16] Update README.rst to correct error --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a21563099a3..214ff2f39e6 100644 --- a/README.rst +++ b/README.rst @@ -124,7 +124,7 @@ Benefits of ScanCode - ScanCode is **actively maintained**, has a **growing users and contributors community**. -- ScanCode is heavily **tested** with an automated test suite of over **20,000 tests**. +- ScanCode is heavily **tested** with an automated test suite of over **30,000 tests**. - ScanCode has an extensive and growing documentation. From ff32855101dc07e00da6f6c3669313b0367494c7 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 12:14:13 -0800 Subject: [PATCH 12/16] Update README.rst to remove extra stuff --- README.rst | 40 +++++++++------------------------------- 1 file changed, 9 insertions(+), 31 deletions(-) diff --git a/README.rst b/README.rst index 214ff2f39e6..d6d50e09a1e 100644 --- a/README.rst +++ b/README.rst @@ -59,15 +59,6 @@ Guidelines for contributing to code development. https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html -Discover also: -============== - -- The ScanCode.io server project here: https://scancodeio.readthedocs.io -- The ScanCode Workbench project for visualization of scancode results data: - https://github.com/nexB/scancode-workbench -- Other companion SCA projects for code origin, license and security analysis - here: https://aboutcode.org - Build and tests status ====================== @@ -83,9 +74,7 @@ compabitility with multiple versions of Windows, Linux and macOS. Benefits of 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 heavily **tested** with an automated test suite of over **30,000 tests**. - ScanCode is **used by several projects and organizations** such as the `Eclipse Foundation `_, @@ -97,6 +86,14 @@ Benefits of ScanCode `RedHat Fabric8 analytics `_, and many more. +- You can also organize and run ScanCode server-side with the + companion `ScanCode.io web app `_ + to organize and store multiple scan projects including scripted scanning pipelines. + +- 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 detects licenses, copyrights, package manifests, direct dependencies, and more both in **source code** and **binary** files and is considered as the best-in-class and reference tool in this domain, re-used as the core tools for @@ -114,30 +111,11 @@ Benefits of ScanCode - You can save your scan results as **JSON, YAML, HTML, CycloneDX or SPDX** or even create your own format with Jinja templates. -- You can also organize and run ScanCode server-side with the - companion `ScanCode.io web app `_ - to organize and store multiple scan projects including scripted scanning pipelines. - -- ScanCode output data can be easily visualized and analysed using the - `ScanCode Workbench `_ desktop app. - -- ScanCode is **actively maintained**, has a **growing users and contributors - community**. - -- ScanCode is heavily **tested** with an automated test suite of over **30,000 tests**. - -- ScanCode has an extensive and growing documentation. - - ScanCode can process packages, build manifest and lockfile formats to collect Package URLs and extract metadata. See all available package parsers `_ for the exhaustive list. -See our `roadmap `_ -for upcoming features. - -See also https://github.com/aboutcode-org/aboutcode?tab=readme-ov-file#aboutcode for related companion projects and tools. - Support ======= From 5997ac9ff866114009bb12f50d0da0fd8416bbc0 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Wed, 17 Dec 2025 13:00:03 -0800 Subject: [PATCH 13/16] Update README.rst technical improvements --- README.rst | 35 ++++++++--------------------------- 1 file changed, 8 insertions(+), 27 deletions(-) diff --git a/README.rst b/README.rst index d6d50e09a1e..cf43e6b5653 100644 --- a/README.rst +++ b/README.rst @@ -119,43 +119,24 @@ Benefits of ScanCode Support ======= -If you have a problem, a suggestion or found a bug, please enter a ticket at: -https://github.com/aboutcode-org/scancode-toolkit/issues +If you have a specific problem, suggestion or bug, please submit a +`GitHub issue `_. -For discussions and chats, we have: +For quick questions or socializing, join the AboutCode community discussions on `Slack `_. -* an official Gitter channel for `web-based chats - `_. - Gitter is now accessible through `Element `_ - or an `IRC bridge `_. - There are other AboutCode project-specific channels available there too. - -* The discussion channel for `scancode `_ - specifically aimed at users and developers using scancode-toolkit. - -Source code and downloads -========================= - -* https://github.com/aboutcode-org/scancode-toolkit/releases -* https://github.com/aboutcode-org/scancode-toolkit.git -* https://pypi.org/project/scancode-toolkit/ -* https://github.com/aboutcode-org/scancode-thirdparty-src.git -* https://github.com/aboutcode-org/scancode-plugins.git -* https://github.com/aboutcode-org/thirdparty-packages.git +Interested in commercial suppport? Contact the `AboutCode team `_. License ======= -* Apache-2.0 is the overall license -* CC-BY-4.0 applies to reference datasets. -* Multiple other secondary permissive or copyleft licenses (LGPL, MIT, +* `Apache-2.0 `_ is the overall license. +* `CC-BY-4.0 `_ applies to reference datasets. +* There are multiple secondary permissive or copyleft licenses (LGPL, MIT, BSD, GPL 2/3, etc.) for third-party components and test suite code and data. -See the NOTICE file and the .ABOUT files that document the origin and license of +See the `NOTICE file `_ and the `.ABOUT files `_ that document the origin and license of the third-party code used in ScanCode for more details. - - .. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop :alt: Azure tests status (Linux, macOS, Windows) From 18d1e16fdd190d17f59feeb23769a789ea8188a0 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Thu, 18 Dec 2025 16:18:26 -0800 Subject: [PATCH 14/16] Update README.rst to remove "deep" links to ReadTheDocs --- README.rst | 53 +++++++++-------------------------------------------- 1 file changed, 9 insertions(+), 44 deletions(-) diff --git a/README.rst b/README.rst index cf43e6b5653..11a0dfa76c0 100644 --- a/README.rst +++ b/README.rst @@ -12,52 +12,17 @@ ScanCode Toolkit is the leading tool in scanning depth and accuracy, used by hun Getting Started =============== -These instructions will get you a copy of the project up and running on your local machine. +Instructions to get you up and running on your local machine are at `Getting Started `_ -https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html +The ScanCode Toolkit documentation also provides: -These instructions will guide you to start scanning code. - -https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/synopsis.html#synopsis-quickstart - -Prerequisites -============= - -What things you need to install the software and how to install them. - -https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#before-installing - -Exploring ScanCode Features -=========================== - -Discover the ScanCode command line options that meet your requirements. - -https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/index.html - -Guided Tours -============ - -These tutorials will provide hands-on guidance to ScanCode features. - -https://scancode-toolkit.readthedocs.io/en/stable/tutorials/index.html - -Advanced Topics -=============== - -Expand the ScanCode Licenses and Detection Rules with your own data. - -https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/index.html - -Generate Attribution from a ScanCode scan. - -https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/generate_attribution.html - -Contributing -============ - -Guidelines for contributing to code development. - -https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html +- prerequisites for installing the software. +- instructions guiding you to start scanning code. +- a comprehensive guide to the command line options. +- tutorials that provide hands-on guidance to ScanCode features. +- how to expand ScanCode Licenses and Detection Rules with your own data. +- how to generate Attribution from a ScanCode scan. +- guidelines for contributing to code development. Build and tests status ====================== From 072f3f9d25f60b4b08758293e8ddf3140bb14669 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Mon, 5 Jan 2026 15:37:38 -0800 Subject: [PATCH 15/16] Update README.rst package parsers link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 11a0dfa76c0..838a99c6c45 100644 --- a/README.rst +++ b/README.rst @@ -77,7 +77,7 @@ Benefits of ScanCode even create your own format with Jinja templates. - ScanCode can process packages, build manifest and lockfile formats to collect - Package URLs and extract metadata. See all available package parsers + Package URLs and extract metadata. See all available `package parsers `_ for the exhaustive list. From e55e7ce50bced876bb1a1401c0d5d830d9177855 Mon Sep 17 00:00:00 2001 From: Dennis Clark Date: Mon, 5 Jan 2026 15:41:01 -0800 Subject: [PATCH 16/16] Update README.rst to fix package parsers --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 838a99c6c45..9da7b7c5cbf 100644 --- a/README.rst +++ b/README.rst @@ -78,7 +78,7 @@ Benefits of ScanCode - ScanCode can process packages, build manifest and lockfile formats to collect Package URLs and extract metadata. See all available `package parsers - `_ + `_ for the exhaustive list. Support