Skip to main content

ScanCode is a tool to scan code for license, copyright, package and their documented dependencies and other interesting facts. scancode-toolkit-mini is a special build that does not come with pre-built binary dependencies by default. These are instead installed separately or with the extra_requires scancode-toolkit-mini[full]

Project description

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.

Check out the code at https://github.com/nexB/scancode-toolkit

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 FSFE, the FSF, OSS Review Toolkit, ClearlyDefined.io, RedHat Fabric8 analytics, and many more.

  • 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 software composition data collection by several open source tools.

  • 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 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.

  • You can save your scan results as JSON, HTML, CSV or SPDX or 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 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 has an extensive and growing documentation.

  • ScanCode can process these packages, build manifest and lockfile formats to extract metadata: Alpine packages, BUCK files, ABOUT files, Android apps, Autotools, Bazel, JavaScript Bower, Java Axis, MS Cab, Rust Cargo, 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, NugGet, 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.

See our roadmap for upcoming features.

Build and tests status

We run tests on multiple CIs to ensure a good platform compabitility and on multiple version of Windows, Linux and macOS.

Appveyor

Azure

RTD Build

Appveyor tests status (Windows)

Azure tests status (Linux, macOS, Windows)

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 that you have installed the prerequisites properly. This means installing Python (Python 3.6 or higher is required).

See prerequisites for detailed information on the support platforms and Python versions.

There are a few common ways to 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

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

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. Gitter is also accessible via an IRC bridge. 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 noisy. You can use your favorite IRC client or use the web chat.

Source code and downloads

License

  • Apache-2.0 as the overall license

  • CC-BY-4.0 for reference datasets (initially was in the Public Domain).

  • Multiple other secondary permissive or copyleft licenses (LGPL, MIT, BSD, GPL 2/3, 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scancode-toolkit-mini-30.0.0.tar.gz (55.6 MB view details)

Uploaded Source

Built Distribution

scancode_toolkit_mini-30.0.0-py3-none-any.whl (67.2 MB view details)

Uploaded Python 3

File details

Details for the file scancode-toolkit-mini-30.0.0.tar.gz.

File metadata

  • Download URL: scancode-toolkit-mini-30.0.0.tar.gz
  • Upload date:
  • Size: 55.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.0

File hashes

Hashes for scancode-toolkit-mini-30.0.0.tar.gz
Algorithm Hash digest
SHA256 23ce681d4348dda1df1e7473bcf247c120b747502ab131c4227f8df609666a4d
MD5 29d7c9305fc1f6b8e24559a8e4e37281
BLAKE2b-256 84bbf3950140b2d632319b5b55f72c7ffef8c639c09e025872ae212fd7e9d43d

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-30.0.0-py3-none-any.whl.

File metadata

  • Download URL: scancode_toolkit_mini-30.0.0-py3-none-any.whl
  • Upload date:
  • Size: 67.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.0

File hashes

Hashes for scancode_toolkit_mini-30.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c68d96d40423b69596006920f6984eb2edc3802329f0300b44aa194eb1b9d36e
MD5 d3d7d54b4ba1fe80e474a4a766325ff6
BLAKE2b-256 f3bce5c1a500a5bf3b0d74abf910c8eddec4347c7bef4a057bcdb22938d2cec6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page