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.

Azure

RTD Build

GitHub actions Docs

GitHub actions Release

Azure tests status (Linux, macOS, Windows)

Documentation Status

Documentation Tests

Release tests

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, 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 20,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: 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 all available package parsers for the exhaustive list.

See our roadmap for upcoming features.

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:

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, 3.10 and 3.11.

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

There are a few common ways to install ScanCode.

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

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

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

Uploaded Source

Built Distributions

scancode_toolkit_mini-32.0.7-cp311-none-any.whl (109.2 MB view details)

Uploaded CPython 3.11

scancode_toolkit_mini-32.0.7-cp310-none-any.whl (109.2 MB view details)

Uploaded CPython 3.10

scancode_toolkit_mini-32.0.7-cp39-none-any.whl (109.2 MB view details)

Uploaded CPython 3.9

scancode_toolkit_mini-32.0.7-cp38-none-any.whl (109.2 MB view details)

Uploaded CPython 3.8

scancode_toolkit_mini-32.0.7-cp37-none-any.whl (109.2 MB view details)

Uploaded CPython 3.7

File details

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

File metadata

File hashes

Hashes for scancode-toolkit-mini-32.0.7.tar.gz
Algorithm Hash digest
SHA256 5c23e33e4a5e5bdd83e934d12fb85ab6f399c1219c22ce43f8774002056434ba
MD5 2addda9f1a6a57417055a72deed44f84
BLAKE2b-256 4324253e89e239deb226a1e22153fb212a69f317f34e535f2810c63d5c920b1c

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.7-cp311-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.7-cp311-none-any.whl
Algorithm Hash digest
SHA256 bb8697fc7b0e4449dda31669d3e70e278142fb2266ea4ece30aa0d5b955d661f
MD5 df3c32019231748dbc1410b07aef3b56
BLAKE2b-256 e1ad4cae9a207d4f194d3d241abfcf6fa1e13cb9b323c9a692ad61333d2c0eb9

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.7-cp310-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.7-cp310-none-any.whl
Algorithm Hash digest
SHA256 6fd42ae2cb4d3a16dab665e4b949f77d263ec63fbd99008bb09ac8c82874bfd6
MD5 ed88e883a003261b4e256faaba1b9cf8
BLAKE2b-256 f0407b55d1bb4b8d0c5e267538510f17bc124df855291c7fcacb33dff50586a7

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.7-cp39-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.7-cp39-none-any.whl
Algorithm Hash digest
SHA256 5941e0680e1a5a1c1c2bd508c4b7af5661871d199bb409f5fa6961a27b4733b7
MD5 777a6339e5080f787633a5715fbcf0cd
BLAKE2b-256 5799f4670b9b7c0fb8107b450cb7e9953af1d43a2087b57f8651bb186649ab87

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.7-cp38-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.7-cp38-none-any.whl
Algorithm Hash digest
SHA256 14fff60f8775cb3fb10fcec37acb69e66eb6b3de86ac1f6cf881dc555e7b8b00
MD5 ef6be2c0395254d2fff39c7de9fe1117
BLAKE2b-256 c4bcb912f8eacf2dde56b230d02004aca387376e263620c131b596541b99dd9e

See more details on using hashes here.

Provenance

File details

Details for the file scancode_toolkit_mini-32.0.7-cp37-none-any.whl.

File metadata

File hashes

Hashes for scancode_toolkit_mini-32.0.7-cp37-none-any.whl
Algorithm Hash digest
SHA256 6fc9fe0b62bc236f2fdb9a70c57b989a4367ef35389e24c47bd8c79b9a101b14
MD5 858edd8d29a327aab238a49a7303a22e
BLAKE2b-256 4acbaede57335f340f34635ff1ee697e62654decd4bb05d8ed77842544fae424

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