Skip to main content

Utility for comparing codebases using scancode-toolkit

Project description

Branch Linux (Travis)
develop https://travis-ci.com/nexB/deltacode.svg?token=9MXbiHv3xZxwT2egFxby&branch=develop

DeltaCode is a simple command line utility that leverages the power of scancode-toolkit to determine file-level differences between two codebases.

During a typical software release cycle, development teams and software compliance experts want insight into how a codebase has changed during each release iteration. Specifically, these users need a utility that can point out places in a codebase where material license and other provenance changes have occurred. This is where DeltaCode comes in.

DeltaCode provides an accurate means of comparing two ScanCode result files, and returning any possible changes that have occurred between the two given scanned codebases. DeltaCode currently has the ability to detect file size and license changes, as well as means to detect when files have been moved to new locations.

We are continuously working on new features, such as detecting copyright changes and detecting package version changes.

Quick Start

For more comprehensive installation instructions and development instructions, see: Comprehensive Installation

For development instructions, see: Development Instructions

Make sure you have Python 2.7 installed:

Next, download and extract the latest DeltaCode release from:

https://github.com/nexB/deltacode/releases/

Open a terminal, extract the downloaded release archive, then cd to the extracted directory and run this command to display the command help. DeltaCode will self-configure if needed:

./deltacode --help

Run a sample delta

./deltacode -n samples/samples.json -o samples/samples.json

Run a simple delta saved to the output.json file:

./deltacode -n samples/samples.json -o samples/samples.json -j output.json

Then open output.json to view the delta results.

To get DeltaCode results for your codebase, install scancode-toolkit and generate a scan for each of the codebases you wish to ‘Delta’

Support

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

For other questions, discussions, and chats, we have:

License

  • Apache-2.0 with an acknowledgement required to accompany the delta output.

See the NOTICE file for more details.

Project details


Release history Release notifications

This version

1.0.0

Download files

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

Files for deltacode, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size deltacode-1.0.0-py2.py3-none-any.whl (18.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page