Skip to content
🔎 ScanCode detects licenses, copyrights, package manifests & dependencies and more by scanning code ... to discover and inventory open source and third-party packages used in your code.
C Python C++ HTML Shell JavaScript Other
Branch: develop
Clone or download
pombredanne Merge pull request #1909 from AyanSinhaMahapatra/fix-links-md
Fix broken links and Add awesome_bot linkcheck
Latest commit 850399b Feb 17, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix Broken Links Feb 15, 2020
docs Add fixes Jan 24, 2020
etc Add trailing line return. Jan 14, 2020
plugins-builtin Bump builtin plugin versions Oct 24, 2019
plugins Handle non-ascii characters properly in scancode-fingerprint #1690 Nov 9, 2019
samples Streamlined samples. Sep 8, 2015
src Merge pull request #1890 from nexB/update-select-ngrams-python3 Feb 17, 2020
tests Merge pull request #1890 from nexB/update-select-ngrams-python3 Feb 17, 2020
thirdparty
.bumpversion.cfg Bump scancode #1778 Oct 23, 2019
.cirrus.yml Cirrus CI: Assume "yes" for pkg-upgrade Sep 12, 2019
.coveragerc Use single coverage entry in .coveragerc #295 Sep 13, 2019
.gitattributes Ensure no Git EOL/autocrlf is taking place #295 Jun 20, 2019
.gitignore Update Consolidation attributes Jul 30, 2019
.travis.yml Add explanations for Travis Tests Feb 17, 2020
AUTHORS.rst Update AUTHORS.rst Feb 27, 2019
CHANGELOG.rst Bump to 3.0.2 Feb 15, 2019
CODE_OF_CONDUCT.rst Add email and chat channel pointers Aug 30, 2019
CONTRIBUTING.rst Merge pull request #1909 from AyanSinhaMahapatra/fix-links-md Feb 17, 2020
INSTALL.rst Move Install guides from README.rst to INSTALL.rst Jan 28, 2020
MANIFEST.in Sync MANIFEST with latest additions #295 Jun 20, 2019
NOTICE NOTICE: Update the Copyright year Jan 11, 2017
README.rst Fix links to Install and Doc contribute guides Jan 28, 2020
apache-2.0.LICENSE Ensure full, verbatim text of Apache license is used Nov 4, 2016
appveyor.yml Adapt CI scripts to latest #295 Aug 30, 2019
azure-pipelines.yml Add pip installation tests #1778 Oct 24, 2019
cc0-1.0.LICENSE Initial commit. Jul 1, 2015
codecov.yml Add codecov configuration Jun 8, 2018
configure configure: Exit when running on Windows Jan 19, 2020
configure.bat Return correct error code on Windows #1577 Jun 20, 2019
conftest.py Remove Py3 test marker, all pass on Python 3 #295 Aug 27, 2019
extractcode #55 Ensured that root scripts can be called from anywhere Aug 14, 2015
extractcode.bat Use Scripts dir rather than bin junction #1129 Jul 20, 2018
scancode Port configure and boostrap scripts to Python3 #295 Jun 20, 2019
scancode-toolkit.ABOUT Streamline Package model fields #1226 and #1324 Dec 26, 2018
scancode.bat Do not use setlocal in Windows BAT #1577 #295 Jun 22, 2019
setup.cfg Cleanup release scripts Oct 24, 2019
setup.py Move consolidation to summarycode Jan 10, 2020

README.rst

ScanCode toolkit

A typical software project often reuses hundreds of third-party packages. License and origin information is not always easy to find and not normalized: ScanCode discovers and normalizes this data for you.

Read more about ScanCode here: scancode-toolkit.readthedocs.io.

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, OpenEmbedded.org, the FSF, OSS Review Toolkit, ClearlyDefined.io, RedHat Fabric8 analytics and many more.
  • ScanCode detects licenses, copyrights, package manifests and direct dependencies and more both in source code and binary files.
  • ScanCode provides the most accurate license detection engine and does a full comparison (aka. diff or red line) between a database of license texts and your code instead of relying only on 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.
  • You can save your scan results as JSON, HTML, CSV or SPDX. And you can use the companion ScanCode workbench GUI app to review and display scan results, statistics and graphics.
  • ScanCode is actively maintained, has a growing community of users.
  • ScanCode is heavily tested with an automated test suite of over 8000 tests.
  • ScanCode has extensive and updated Documentation help for users.

See our roadmap for upcoming features.

Build and tests status

Branch Coverage Linux/macOS Windows
Master Master branch test coverage (Linux) Linux Master branch tests status Windows Master branch tests status
Develop Develop branch test coverage (Linux) Linux Develop branch tests status Windows Develop branch tests status

Documentation Build

Version RTD Build
Latest Documentation Status

Documentation

The ScanCode documentation is hosted at scancode-toolkit.readthedocs.io.

If you are new to Scancode, start here.

Other Important Documentation Pages:

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 for detailed information on all different platforms and Python Versions.

There are 3 main ways you can install ScanCode.

Quick Start

Note the 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 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 and How to specify Scancode Output Format for more information.

You can also refer to Command Line Options Synopsis and an exhaustive List of All Available Options.

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:

./extractcode mytar.tar.bz2

Refer All Extractcode Options and How To Extract Archives for more information.

Support

If you have a problem, a suggestion or found a bug, please enter a ticket at: https://github.com/nexB/scancode-toolkit/issues

For discussions and chats, we have:

Source code and downloads

License

  • Apache-2.0 with an acknowledgement required to accompany the scan output.
  • Public domain CC-0 for reference datasets.
  • Multiple licenses (GPL2/3, LGPL, MIT, BSD, etc.) for third-party components.

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.

You can’t perform that action at this time.