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 packages, dependencies 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: https://scancode-toolkit.readthedocs.io/.

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

Discover also:

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.

Appveyor

Azure

RTD Build

Appveyor tests status (Windows)

Azure tests status (Linux, macOS, Windows)

Documentation Status

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 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, 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 and the Windows registry and a few more.

See our roadmap for upcoming features.

Documentation

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

If you are new to Scancode, 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:

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.8 for x86/64 architectures. We support Python 3.8, 3.9 and 3.10.

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 liberachat (server web.libera.chat). 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 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.

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-32.0.0rc1.tar.gz (14.4 MB view details)

Uploaded Source

Built Distributions

scancode_toolkit_mini-32.0.0rc1-cp310-none-any.whl (102.4 MB view details)

Uploaded CPython 3.10

scancode_toolkit_mini-32.0.0rc1-cp39-none-any.whl (102.4 MB view details)

Uploaded CPython 3.9

scancode_toolkit_mini-32.0.0rc1-cp38-none-any.whl (102.4 MB view details)

Uploaded CPython 3.8

scancode_toolkit_mini-32.0.0rc1-cp37-none-any.whl (102.4 MB view details)

Uploaded CPython 3.7

File details

Details for the file scancode-toolkit-mini-32.0.0rc1.tar.gz.

File metadata

File hashes

Hashes for scancode-toolkit-mini-32.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 5ed288a6244deebe1246f1c4fbce55b8d8c969a9cfab5e8eaaea5e2a92c87a2d
MD5 b784b276e7b5128b734afa8551c70885
BLAKE2b-256 8b6b24b80c1178d7ca9c26e6d0768f7a8f5f2852894af6ad176c220c73d10624

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.0rc1-cp310-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.0rc1-cp310-none-any.whl
Algorithm Hash digest
SHA256 1a91eb655b1afe020744b3a43e184631ff1d976de225b794d809053ced589fb2
MD5 56099b4629db69aae0ded90b0e0500d3
BLAKE2b-256 ddc88f9850683d5556abba24d52031b02363e361e84d874baead93280450fb86

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.0rc1-cp39-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.0rc1-cp39-none-any.whl
Algorithm Hash digest
SHA256 51498426be0d4520c1d5aa41b6f78c252ec94ff452914a835ee765d04e590cec
MD5 7caa740379a33c36ea60ea5ee6b3b7fa
BLAKE2b-256 78da914c09d220db538594c649b16b8c7828b41aa1c7ef6f5ac0b4f040b79f19

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.0rc1-cp38-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.0rc1-cp38-none-any.whl
Algorithm Hash digest
SHA256 94dc2d4daf18f3594c9b2f1d20a2d1d9cc9dbbe8a43b591e20d6d8fe5a83e3c5
MD5 d379d65326f7f080907fc039c4525b35
BLAKE2b-256 1eac817cc7c460589f150c0cb1f82db90d306da5bbbc26d523494cbd58a20413

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.0rc1-cp37-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.0rc1-cp37-none-any.whl
Algorithm Hash digest
SHA256 cc95a27c9c4f6eed15f2226c597fb7cdd244a957fb868ad1c1986c72673474d2
MD5 20ecfdc6b115e8a0cfbc4be69e205068
BLAKE2b-256 e204503c73e4cffcf03d489b959f554d55f739894168fc8b8eeefb8ec4ec23be

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