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
Develop

Documentation Build

Version	RTD Build
Latest

Documentation

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

If you are new to Scancode, start here.

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:

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 #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/
a Gitter channel to discuss Documentation at https://gitter.im/aboutcode-org/gsod-season-of-docs

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.

doc22940 / scancode-toolkit Goto Github PK