Differences between revisions 1 and 11 (spanning 10 versions)
Revision 1 as of 2016-06-14 11:12:40
Size: 832
Editor: wookey
Comment:
Revision 11 as of 2017-01-31 13:59:00
Size: 5992
Comment: Add section Other copyright files and license-related tools
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Reviewing upstream packages to write debian/copyright files is tedious manual work. It tends not to get done again after initial packaging, especially not on every release (when something may have changed). Reviewing upstream packages to write debian/copyright files is tedious but important manual work. It is done during initial packaging and after every new upstream release.
Line 3: Line 3:
Making initial copyright file construction, and subsequent review/update easier will improve Debian's software quality. Making initial copyright file construction and subsequent review/update easier will improve Debian's software quality.
Line 5: Line 5:
Stretch (Debian 9) has significantly improved tools over previous releases.  Starting with Stretch (Debian 9) there are significantly improved tools over previous releases to help.
Line 7: Line 7:
scan-copyrights can update an existing copyright file from rescanning the source. It can also create one from scratch. It uses the underlying licensecheck tool from devscripts Note that some of the tools listed here are run by `check-all-the-things -f copyright`.
Line 9: Line 9:
The package needed is cme (and libconfig-model-dpkg-perl v2.074 or later)  * `licensecheck` from DebianPackage:licensecheck (and older versions of DebianPackage:devscripts) can scan source code and report found copyright holders and known licenses. Its approach is to detect licenses with a dataset (medium:~200 regexes) of regex patterns and key phrases (parts) and to reassemble these in detected licenses based on rules. In that sense this is somewhat similar to the combined approaches of Fossology/nomos and Ninka (see below for these tools). It also detects copyright statements. It output results in plain text (with customizable delimiter) or a Debian copyright file format. This is a command line tool written in Perl.
Line 11: Line 11:
updating is as simple as:
 * `scan-copyrights` from DebianPackage:libconfig-model-dpkg-perl can update an existing copyright file from rescanning the source. It can also create one from scratch. It uses `licensecheck`.

 * Config::Model can update Debian copyright files using the `cme` command (from DebianPackage:cme or DebianPackage:libconfig-model-dpkg-perl less than 2.063):

{{{
Line 13: Line 18:
}}}
Line 14: Line 20:
More details here:
https://github.com/dod38fr/config-model/wiki/Updating-debian-copyright-file-with-cme
 * A script from DebianPackage:cdbs can generate a copyright file using `licensecheck`:

{{{
licensecheck --copyright -r `find * -type f` | \
  /usr/lib/cdbs/licensecheck2dep5 > debian/copyright.auto
}}}

 * `license-reconcile` compares the existing copyright with the source code and reports discrepancies.

 * `debmake -k` also compares the existing copyright with the source code and reports discrepancies.

 * `debmake -cc` generates a new copyright file from the source code.

 * `decopy` generates debian/copyright files.

 * `licensee` from DebianPackage:ruby-licensee checks LICENSE files and returns known license names. This is the [[https://github.com/benbalter/licensee| tool used by Github]] to provide a summary license indication on a repository main page. Its approach is to search for typical LICENSE file names or some package manifest (NPM, Bower, Gemfile, etc) and perform an exact or approximate license text matching against the set of common licenses texts as published at [[https://choosealicense.com]] (small: ~20). It output results in YAML format. This is a command line tool written in Ruby.

 * [[https://www.fossology.org/|FOSSology]] is a open source license compliance software system and toolkit that [[https://debconf16.debconf.org/talks/100/|can]] (in version 3.1) generate DEP5 copyright files. Its approach is to detect licenses with a either large (large:~6000 regexes) dataset of regex patterns (nomos) or a full string comparison against license full texts (large: ~400 text) (monk). It also detects copyright statements and does also integrate with Ninka (see below). This is a complete database-backed web application with some command line support written in C/C++ with a PHP frontend.

 * [[https://github.com/pivotal/LicenseFinder|LicenseFinder]] is a tool that "Find licenses for your project's dependencies." It does so by running application-specific package management tools and detecting package manifests to collect license-related metadata (e.g. Gemfile, etc) and detect licensing using regex against a set of common license texts (small: ~20). It output results in CSV, HTML and other report format. This is a command line tool written in Ruby.

 * [[https://github.com/dmgerman/ninka|Ninka]] is a "license identification tool for Source Code". Its approach is to detect licenses from text sentences using a dataset of key license sentences (large: ~600) and assemble the results based on the matched sentences. It output results in CSV format. This is a command line tool written in Perl.

 * [[https://github.com/nexB/scancode-toolkit/|ScanCode]] is a tool "to scan code and detect licenses, copyrights and more". Its approach is to detect licenses using a dataset of plain license texts (large:~1000 texts) and plain text notices (large:~2500 notices and mentions) and finds exact and approximate matches in source and binaries using full text alignments. It also detects copyright statements and collect license metadata from package manifests (e.g Maven, Pypi, etc.). It output results in JSON, HTML or SPDX format. This is a command line tool written in Python.


= Other copyright files and license-related tools =

 * In Python:
  * [[https://packages.qa.debian.org/p/python-debian.html|python-debian]] has support parsing and creating copyright files (and any Debian-style files such as description, control, Sources, Packages, etc.)
  * [[dlt|https://github.com/agustinhenze/dlt/]] has support for parsing and creating copyright files.
  * [decopy|https://anonscm.debian.org/git/collab-maint/decopy.git/]] is a tool that "automates creating and updating the debian/copyright files." and also "decopy aims to detects as many licenses as possible" which would make it a tool for license detection too. It uses `python-debian` to handle copyright files.
  * [[Debian packaging tools|https://github.com/xolox/python-deb-pkg-tools]] is "a collection of functions to work with Debian packages and repositories. It uses `python-debian` to handle copyright files.


= See also =


 * [[https://github.com/dod38fr/config-model/wiki/Updating-debian-copyright-file-with-cme|Updating debian copyright file with cme]] by Dominique Dumont
 * [[http://people.skolelinux.org/pere/blog/Creating__updating_and_checking_debian_copyright_semi_automatically.html|Creating, updating and checking debian/copyright semi-automatically]] by Petter Reinholdtsen

Reviewing upstream packages to write debian/copyright files is tedious but important manual work. It is done during initial packaging and after every new upstream release.

Making initial copyright file construction and subsequent review/update easier will improve Debian's software quality.

Starting with Stretch (Debian 9) there are significantly improved tools over previous releases to help.

Note that some of the tools listed here are run by check-all-the-things -f copyright.

  • licensecheck from licensecheck (and older versions of devscripts) can scan source code and report found copyright holders and known licenses. Its approach is to detect licenses with a dataset (medium:~200 regexes) of regex patterns and key phrases (parts) and to reassemble these in detected licenses based on rules. In that sense this is somewhat similar to the combined approaches of Fossology/nomos and Ninka (see below for these tools). It also detects copyright statements. It output results in plain text (with customizable delimiter) or a Debian copyright file format. This is a command line tool written in Perl.

  • scan-copyrights from libconfig-model-dpkg-perl can update an existing copyright file from rescanning the source. It can also create one from scratch. It uses licensecheck.

  • Config::Model can update Debian copyright files using the cme command (from cme or libconfig-model-dpkg-perl less than 2.063):

cme update dpkg-copyright
  • A script from cdbs can generate a copyright file using licensecheck:

licensecheck --copyright -r `find * -type f` | \
  /usr/lib/cdbs/licensecheck2dep5 > debian/copyright.auto
  • license-reconcile compares the existing copyright with the source code and reports discrepancies.

  • debmake -k also compares the existing copyright with the source code and reports discrepancies.

  • debmake -cc generates a new copyright file from the source code.

  • decopy generates debian/copyright files.

  • licensee from ruby-licensee checks LICENSE files and returns known license names. This is the tool used by Github to provide a summary license indication on a repository main page. Its approach is to search for typical LICENSE file names or some package manifest (NPM, Bower, Gemfile, etc) and perform an exact or approximate license text matching against the set of common licenses texts as published at https://choosealicense.com (small: ~20). It output results in YAML format. This is a command line tool written in Ruby.

  • FOSSology is a open source license compliance software system and toolkit that can (in version 3.1) generate DEP5 copyright files. Its approach is to detect licenses with a either large (large:~6000 regexes) dataset of regex patterns (nomos) or a full string comparison against license full texts (large: ~400 text) (monk). It also detects copyright statements and does also integrate with Ninka (see below). This is a complete database-backed web application with some command line support written in C/C++ with a PHP frontend.

  • LicenseFinder is a tool that "Find licenses for your project's dependencies." It does so by running application-specific package management tools and detecting package manifests to collect license-related metadata (e.g. Gemfile, etc) and detect licensing using regex against a set of common license texts (small: ~20). It output results in CSV, HTML and other report format. This is a command line tool written in Ruby.

  • Ninka is a "license identification tool for Source Code". Its approach is to detect licenses from text sentences using a dataset of key license sentences (large: ~600) and assemble the results based on the matched sentences. It output results in CSV format. This is a command line tool written in Perl.

  • ScanCode is a tool "to scan code and detect licenses, copyrights and more". Its approach is to detect licenses using a dataset of plain license texts (large:~1000 texts) and plain text notices (large:~2500 notices and mentions) and finds exact and approximate matches in source and binaries using full text alignments. It also detects copyright statements and collect license metadata from package manifests (e.g Maven, Pypi, etc.). It output results in JSON, HTML or SPDX format. This is a command line tool written in Python.

Other copyright files and license-related tools

  • In Python:
    • python-debian has support parsing and creating copyright files (and any Debian-style files such as description, control, Sources, Packages, etc.)

    • ?https://github.com/agustinhenze/dlt/ has support for parsing and creating copyright files.

    • [decopy|https://anonscm.debian.org/git/collab-maint/decopy.git/]] is a tool that "automates creating and updating the debian/copyright files." and also "decopy aims to detects as many licenses as possible" which would make it a tool for license detection too. It uses python-debian to handle copyright files.

    • ?https://github.com/xolox/python-deb-pkg-tools is "a collection of functions to work with Debian packages and repositories. It uses python-debian to handle copyright files.

See also