Welcome to reuse’s documentation!¶
reuse¶
reuse is a tool for compliance with the REUSE recommendations.
Documentation: https://reuse.readthedocs.io and https://reuse.software
Source code: https://github.com/fsfe/reuse-tool
REUSE: 3.0
Python: 3.6+
Background¶
Copyright and licensing is difficult, especially when reusing software from different projects that are released under various different licenses. REUSE was started by the Free Software Foundation Europe (FSFE) to provide a set of recommendations to make licensing your Free Software projects easier. Not only do these recommendations make it easier for you to declare the licenses under which your works are released, but they also make it easier for a computer to understand how your project is licensed.
As a short summary, the recommendations are threefold:
Choose and provide licenses
Add copyright and licensing information to each file
Confirm REUSE compliance
You are recommended to read our tutorial for a step-by-step guide through these three steps. The FAQ covers basic questions about licensing, copyright, and more complex use cases. Advanced users and integrators will find the full specification helpful.
This tool exists to facilitate the developer in complying with the above recommendations.
There are other tools that have a lot more features and functionality surrounding the analysis and inspection of copyright and licenses in software projects. The REUSE helper tool, on the other hand, is solely designed to be a simple tool to assist in compliance with the REUSE recommendations.
Example demo¶
In this screencast, we are going to follow the tutorial, making the REUSE example repository compliant.
Install¶
Installation via pip¶
To install reuse, you need to have the following pieces of software on your computer:
Python 3.6+
pip
You then only need to run the following command:
pip3 install --user reuse
After this, make sure that ~/.local/bin
is in your $PATH
. On
Windows, the required path for your environment may look like
%USERPROFILE%\AppData\Roaming\Python\Python39\Scripts
, depending on
the Python version you have installed.
To update reuse, run this command:
pip3 install --user --upgrade reuse
For full functionality, the following pieces of software are recommended:
Git
Mercurial 4.3+
Installation via package managers¶
There are packages available for easy install on some operating systems. You are welcome to help us package this tool for more distributions!
Installation from source¶
You can also install this tool from the source code, but we recommend the methods above for easier and more stable updates. Please make sure the requirements for the installation via pip are present on your machine.
python3 setup.py install
Usage¶
First, read the REUSE tutorial. In a nutshell:
Put your licenses in the
LICENSES/
directory.Add a comment header to each file that says
SPDX-License-Identifier: GPL-3.0-or-later
, andSPDX-FileCopyrightText: $YEAR $NAME
. You can be flexible with the format, just make sure that the line starts withSPDX-FileCopyrightText:
.Verify your work using this tool.
Example of header:
# SPDX-FileCopyrightText: 2017 Free Software Foundation Europe e.V. <https://fsfe.org>
#
# SPDX-License-Identifier: CC-BY-SA-4.0
To check against the recommendations, use reuse lint
:
~/Projects/reuse-tool $ reuse lint
[...]
Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)
This tool can do various more things, detailed in the documentation. Here a short summary:
addheader
— Add copyright and/or licensing information to the header of a file.download
— Download the specified license into theLICENSES/
directory.init
— Set up the project for REUSE compliance.lint
— Verify the project for REUSE compliance.spdx
— Generate an SPDX Document of all files in the project.
Run in Docker¶
The fsfe/reuse
Docker image is available on Docker
Hub. With it, you can easily include REUSE
in CI/CD processes. This way, you can check for REUSE compliance for each build.
In our resources for developers you can learn how
to integrate the REUSE tool in Drone, Travis, GitHub, or GitLab CI.
You can run the helper tool simply by providing the command you want to run
(e.g., lint
, spdx
). The image’s working directory is /data
by default. So
if you want to lint a project that is in your current working directory, you can
mount it on the container’s /data
directory, and tell the tool to lint. That
looks a little like this:
docker run --volume $(pwd):/data fsfe/reuse lint
You can also provide additional arguments, like so:
docker run --volume $(pwd):/data fsfe/reuse --include-submodules spdx -o out.spdx
Run as pre-commit hook¶
You can automatically run reuse lint
on every commit as a pre-commit hook for
Git. This uses pre-commit. Once you have it
installed, add this to the
.pre-commit-config.yaml
in your repository:
repos:
- repo: https://github.com/fsfe/reuse-tool
rev: latest
hooks:
- id: reuse
Then run pre-commit install
. Now, every time you commit, reuse lint
is run
in the background, and will prevent your commit from going through if there was
an error.
Maintainers¶
Carmen Bianca Bakker - carmenbianca@fsfe.org
Contribute¶
Any pull requests or suggestions are welcome at https://github.com/fsfe/reuse-tool or via e-mail to one of the maintainers. General inquiries can be sent to reuse@lists.fsfe.org.
Interaction within this project is covered by the FSFE’s Code of Conduct.
Starting local development is very simple, just execute the following commands:
git clone git@github.com:fsfe/reuse-tool.git
cd reuse-tool/
python3 -mvenv venv
source venv/bin/activate
make develop
You need to run make develop
at least once to set up the virtualenv.
Next, run make help
to see the available interactions.
License¶
This work is licensed under multiple licences. Because keeping this section up-to-date is challenging, here is a brief summary as of April 2020:
All original source code is licensed under GPL-3.0-or-later.
All documentation is licensed under CC-BY-SA-4.0.
Some configuration and data files are licensed under CC0-1.0.
Some code borrowed from spdx/tool-python is licensed under Apache-2.0.
For more accurate information, check the individual files.
Usage¶
The overview documents some basic usage on how to use this tool.
It is highly recommended to read the overview first, and you might not even need
to read this chapter. This chapter covers details that might not be immediately
obvious when using the tool. This chapter does not cover everything, assuming
that the user is helped enough by reuse --help
and reuse <subcommand>
--help
.
Implementation details¶
This section covers implementation details that are true for the entire tool.
When searching for copyright and licensing tags inside of files, the tool does not strictly limit itself to the header comment as prescribed by the specification. It searches the first 4 kibibytes of the file. This makes sure that the tool can parse any type of plain-text file, even if the comment style is not recognised.
If a file is found to have an unparseable tag, that file is not parsed at all. This is a bug.
The tool does not verify the correctness of copyright notices. If it finds any line containing ‘©’, ‘Copyright’, or ‘SPDX-FileCopyrightText:’, then the tag and everything following it is considered a valid copyright notice, even if the copyright notice is not compliant with the specification.
When running the tool, the root of the project is automatically found if the
working directory is inside a VCS repository. Otherwise, it treats the working
directory as the root of the project. You can override the root of the project
with the --root
optional argument.
Git submodules are automatically ignored unless --include-submodules
is
passed as optional argument.
Symbolically links and files that are zero-sized are automatically ignored.
addheader¶
addheader
makes it possible to semi-automatically add copyright and
licensing information into the header of a file. This is useful especially in
scenarios where you want to add a copyright holder or license to a lot of files
without having to manually edit the header of each file.
Warning
You should be cautious with using addheader
in automated processes. While
nothing is stopping you from using it in your release script, you should make
sure that the information it adds is actually reflective of reality. This is
best verified manually.
The basic usage is reuse addheader --copyright="Jane Doe" --license=MIT
my_file.py
. This will add the following header to the file (assuming that the
current year is 2019):
# SPDX-FileCopyrightText: 2019 Jane Doe
#
# SPDX-License-Identifier: MIT
You can use as many --copyright
and --license
arguments, so long as
there is at least one such argument.
The REUSE header is placed at the very top of the file. If a different REUSE header already existed—at the top or elsewhere—its tags are copied, and the header is replaced in-place.
With the argument --copyright-style
it is posible to change the default
SPDX-FileCopyrightText
to one of the following style:
spdx: SPDX-FileCopyrightText: <year> <statement>
string: Copyright <year> <statement>
string-c: Copyright (C) <year> <statement>
string-symbol: Copyright © <year> <statement>
symbol: © <year> <statement>
Shebangs are always preserved at the top of the file.
Comment styles¶
The tool normally tries to auto-detect the comment style to use from the file
extension of a file, and use that comment style. If the tool is unable to detect
the comment style, or if it detects the wrong style, you can override the style
using --style
. The supported styles are:
AppleScript
ASPX
BibTex
C
CSS
Haskell
HTML
Jinja
JSX
ML
Python
TeX
If your comment style is not supported or a file extension is not correctly detected, please open an issue.
Normally, the tool uses a single-line comment style when it is available (e.g., // is used instead of /* */ for C comment styles). If no single-line comment style is available, a multi-line style is used. You can force a certain comment style using –single-line or –multi-line.
Templates¶
When the tool adds a header to a file, it normally first lists all copyright statements alphabetically, adds a single empty line, and then lists all SPDX License Expressions alphabetically. That is all that the header contains. It is possible to change this behaviour, and use a custom type of header that contains extra text. This is done through Jinja2 templates.
The default template is:
{% for copyright_line in copyright_lines %}
{{ copyright_line }}
{% endfor %}
{% for expression in spdx_expressions %}
SPDX-License-Identifier: {{ expression }}
{% endfor %}
Templates are automatically commented by the tool, depending on the detected or specified comment style.
You can create your own Jinja2 templates and place them in
.reuse/templates/
. If you create the template mytemplate.jinja2
, you can
use it with reuse addheader --copyright="Jane Doe" --template=mytemplate
foo.py
.
Inside of the template, you have access to the following variables:
copyright_lines
— a list of copyright notices (string).spdx_expressions
— a list of SPDX License Expressions (string).
In the future, more variables will be added.
In some cases, you might want to do custom comment formatting. In those cases,
you can pre-format your header as a comment. When doing so, suffix your template
with .commented.jinja2
.
An example of a custom template with manual commenting is:
/*
{% for copyright_line in copyright_lines %}
* {{ copyright_line }}
{% endfor %}
{% if copyright_lines and spdx_expressions %}
*
{% endif %}
{% for expression in spdx_expressions %}
* SPDX-License-Identifier: {{ expression }}
{% endfor %}
{% if "GPL-3.0-or-later" in spdx_expressions %}
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program. If not, see <https://www.gnu.org/licenses/>.
{% endif %}
*/
lint¶
lint
is the main component of the tool. Summarily, it verifies whether the
project is compliant with the REUSE Specification. Its main goal is to find all files that do not
have copyright and licensing information in their headers, but it also checks a
few other things.
The STDOUT output of reuse lint
is valid Markdown. Occasionally some logging
will be printed to STDERR, which is not valid Markdown.
This is some example output of reuse lint
:
# BAD LICENSES
'bad-license' found in:
* LICENSES/bad-license.txt
# UNUSED LICENSES
The following licenses are not used:
* bad-license
# MISSING COPYRIGHT AND LICENSING INFORMATION
The following files have no copyright and licensing information:
* no-information.txt
# SUMMARY
* Bad licenses: bad-license
* Deprecated licenses:
* Licenses without file extension:
* Missing licenses:
* Unused licenses: bad-license
* Used licenses: Apache-2.0, CC-BY-SA-4.0, CC0-1.0, GPL-3.0-or-later
* Read errors: 0
* Files with copyright information: 57 / 58
* Files with license information: 57 / 58
Unfortunately, your project is not compliant with version 3.0 of the REUSE Specification :-(
Criteria¶
These are the criteria that the linter checks against:
Bad licenses¶
Licenses that are found in LICENSES/
that are not found in the SPDX License
List or do not start with LicenseRef-
are bad licenses.
Deprecated licenses¶
If a license has an SPDX License Identifier that has been deprecated by SPDX, the license will show up here.
Licenses without file extension¶
These are licenses whose file names are a valid SPDX License Identifier, but which do not have a file extension.
Missing licenses¶
If a license is referred to in a comment header, but the license is not found in
the LICENSES/
directory, then that license is missing.
Unused licenses¶
Conversely, if a license is found in the LICENSES/
directory but is not
referred to in any comment header, then that license is unused.
Read errors¶
Not technically a criterion, but files that cannot be read by the operating system are read errors, and need to be fixed.
Files with copyright and license information¶
Every file needs to have copyright and licensing information associated with it. The REUSE Specification details several ways of doing it. By and large, these are the methods:
Placing tags in the header of the file.
Placing tags in a
.license
file adjacent to the file.Putting the information in the DEP5 file.
If a file is found that does not have copyright and/or license information associated with it, then the project is not compliant.
Credits¶
Development Lead¶
Carmen Bianca Bakker <carmenbianca@fsfe.org>
Contributors¶
Sebastian Schuberth <schuberth@fsfe.org>
Max Mehl <max.mehl@fsfe.org>
Matija Šuklje <hook@fsfe.org>
Greg Kroah-Hartman
Basil Peace
Keith Maxwell
Stefan Bakker <s.bakker777@gmail.com>
Kirill Elagin <kirelagin@gmail.com>
John Mulligan <jmulligan@redhat.com>
Tuomas Siipola <tuomas@zpl.fi>
Diego Elio Pettenò <flameeyes@flameeyes.com>
David Alfonso
Maximilian Dolling <mdolling@gfz-potsdam.de>
Translators¶
Dutch:
André Ockers <ao@fsfe.org>
Carmen Bianca Bakker <carmenbianca@fsfe.org>
French:
OliBug <act-zebug@riseup.net>
Vincent Lequertier <vincent@fsfe.org>
Galician:
pd <euklade@gmail.com>
German:
Max Mehl <max.mehl@fsfe.org>
Thomas Doczkal <doczkal@fsfe.org>
Esperanto:
Carmen Bianca Bakker <carmenbianca@fsfe.org>
Tirifto <tirifto@posteo.cz>
Italian:
Luca Bonissi <lucabon@fsfe.org>
Portuguese:
José Vieira <jvieira33@sapo.pt>
Spanish:
flow <adolflow@sindominio.net>
pd <euklade@gmail.com>
Roberto Bauglir <bauglir@fsfe.org>
Turkish:
Kalayci <tekrei@member.fsf.org>
Change log¶
This change log follows the Keep a Changelog spec. Every release contains the following sections:
Added
for new features.Changed
for changes in existing functionality.Deprecated
for soon-to-be removed features.Removed
for now removed features.Fixed
for any bug fixes.Security
in case of vulnerabilities.
The versions follow semantic versioning.
0.12.0 - 2020-12-16¶
This release was delayed due to the absence of the lead developer (Carmen, me, the person writing these release notes). Many thanks to Max Mehl for coordinating the project in my absence. Many thanks also to the contributors who sent in pull requests, in reverse chronological order: Olaf Meeuwissen, Mikko Piuola, Wolfgang Traylor, Paul Spooren, Robert Cohn, ethulhu, pukkamustard, and Diego Elio Pettenò.
Added¶
Separate Docker image with additional executables installed (
fsfe/reuse:latest-extra
) (#238)Allow different styles of copyright lines: SPDX (default), String, String (C), String ©, and © (#248)
Convenience function to update resources (SPDX license list and exceptions) (#268)
More file types are recognised:
ClojureScript (
.cljc
,.cljs
)Fortran (
.F
,.F90
,.f90
,.f95
,.f03
,.f
,.for
)Makefile (
.mk
)PlantUML (
.iuml
,.plantuml
,.pu
,.puml
)R (
.R
,.Renviron
,.Rprofile
)ReStructured Text (
.rst
)RMarkdown (
.Rmd
)Scheme (
.scm
)TypeScript (
.ts
)TypeScript JSX (
.tsx
)Windows Batch (
.bat
)
More file names are recognised:
.dockerignore
Gemfile
go.mod
meson.build
Rakefile
Changed¶
Use UTF-8 explicitly when reading files (#242)
Fixed¶
Updated license list to 3.11.
0.11.1 - 2020-06-08¶
Fixed¶
Similar to CAL-1.0 and CAL-1.0-Combined-Work-Exception, SHL-2.1 is now ignored because it contains an SPDX tag within itself.
0.11.0 - 2020-05-25¶
Added¶
Added
--skip-unrecognised
flag toaddheader
in order to skip files with unrecognised comment styles instead of aborting without processing any file.
Changed¶
Always write the output files encoded in UTF-8, explicitly. This is already the default on most Unix systems, but it was not on Windows.
All symlinks and 0-sized files in projects are now ignored.
Fixed¶
The licenses CAL-1.0 and CAL-1.0-Combined-Work-Exception contain an SPDX tag within themselves. Files that are named after these licenses are now ignored.
Fixed a bug where
addheader
wouldn’t properly apply the template on.license
files if the.license
file was non-empty, but did not contain valid SPDX tags.
0.10.0 - 2020-04-24¶
Added¶
Add support for autoconf comment style (listed as m4).
More file types are recognised:
Cython (
.pyx
,.pxd
)Sass and SCSS (
.sass
,.scss
)XSL (
.xsl
)Mailmap (
.mailmap
)
Added
--single-line
and--multi-line
flags toaddheader
. These flags force a certain comment style.
Changed¶
The Docker image has an entrypoint now. In effect, this means running:
docker run -v $(pwd):/data fsfe/reuse lint
instead of
docker run -v $(pwd):/data fsfe/reuse reuse lint
.
0.9.0 - 2020-04-21¶
Added¶
Added support for Mercurial 4.3+.
A pre-commit hook has been added.
When an incorrect SPDX identifier is forwarded to
download
orinit
, the tool now suggests what you might have meant.
Changed¶
Under the hood, a lot of code that has to do with Git and Mercurial was moved into its own module.
The Docker image has been changed such that it now automagically runs
reuse lint
on the/data
directory unless something else is specified by the user.
Fixed¶
Fixed a bug with
addheader --explicit-license
that would result infile.license.license
iffile.license
already existed.Fixed a Windows-only bug to do with calling subprocesses.
Fixed a rare bug that would trigger when a directory is both ignored and contains a
.git
file.
0.8.1 - 2020-02-22¶
Added¶
Support Jinja (Jinja2) comment style.
Support all multi-line comment endings when parsing for SPDX information.
Fixed¶
Improvements to German translation by Thomas Doczkal.
No longer remove newlines at the end of files when using
addheader
.There can now be a tab as whitespace after
SPDX-License-Identifier
andSPDX-FileCopyrightText
.
0.8.0 - 2020-01-20¶
Added¶
Implemented
--root
argument to specify the root of the project without heuristics.The linter will complain about licenses without file extensions.
Deprecated licenses are now recognised.
lint
will complain about deprecated licenses.ProjectReport generation (
lint
,spdx
) now uses Python multiprocessing, more commonly called multi-threading outside of Python. This has a significant speedup of approximately 300% in testing. Because of overhead, performance increase is not exactly linear.For setups where multiprocessing is unsupported or unwanted,
--no-multiprocessing
is added as flag.addheader
now recognises many more extensions. Too many to list here.addheader
now also recognises full filenames such asMakefile
and.gitignore
.Added BibTex comment style.
Updated translations:
Dutch (André Ockers, Carmen Bianca Bakker)
French (OliBug, Vincent Lequertier)
Galician (pd)
German (Max Mehl)
Esperanto (Carmen Bianca Bakker)
Portuguese (José Vieira)
Spanish (Roberto Bauglir)
Turkish (T. E. Kalayci)
Changed¶
The linter output has been very slightly re-ordered to be more internally consistent.
reuse --version
now prints a version with a Git hash on development versions. Towards that end, the tool now depends onsetuptools-scm
during setup. It is not a runtime dependency.
Removed¶
lint
no longer accepts path arguments. Where previously one could doreuse lint SUBDIRECTORY
, this is no longer possible. When linting, you must always lint the entire project. To change the project’s root, use--root
.FileReportInfo
has been removed.FileReport
is used instead.
Fixed¶
A license that does not have a file extension, but whose full name is a valid SPDX License Identifier, is now correctly identified as such. The linter will complain about them, however.
If the linter detects a license as being a bad license, that license can now also be detected as being missing.
Performance of
project.all_files()
has been improved by quite a lot.Files with CRLF line endings are now better supported.
0.7.0 - 2019-11-28¶
Changed¶
The program’s package name on PyPI has been changed from
fsfe-reuse
toreuse
.fsfe-reuse==1.0.0
has been created as an alias that depends onreuse
.fsfe-reuse
will not receive any more updates, but will still host the old versions.For users of
fsfe-reuse
, this means:If you depend on
fsfe-reuse
orfsfe-reuse>=0.X.Y
in your requirements.txt, you will get the latest version ofreuse
when you installfsfe-reuse
. You may like to change the name toreuse
explicitly, but this is not strictly necessary.If you depend on
fsfe-reuse==0.X.Y
, then you will keep getting that version. When you bump the version you depend on, you will need to change the name toreuse
.If you depend on
fsfe-reuse>=0.X.Y<1.0.0
, then 0.6.0 will be the latest version you receive. In order to get a later version, you will need to change the name toreuse
.
0.6.0 - 2019-11-19¶
Added¶
--include-submodules
is added to also include submodules when linting et cetera.addheader
now also recognises the following extensions:.kt
.xml
.yaml
.yml
Changed¶
Made the workaround for
MachineReadableFormatError
introduced in 0.5.2 more generic.Improved shebang detection in
addheader
.For
addheader
, the SPDX comment block now need not be the first thing in the file. It will find the SPDX comment block and deal with it in-place.Git submodules are now ignored by default.
addheader --explicit-license
now no longer breaks on unsupported filetypes.
0.5.2 - 2019-10-27¶
Added¶
python3 -m reuse
now works.
Changed¶
Updated license list to 3.6-2-g2a14810.
Fixed¶
Performance of
reuse lint
improved by at least a factor of 2. It no longer does any checksums on files behind the scenes.Also handle
MachineReadableFormatError
when parsing DEP5 files. Tries to import that error. If the import is unsuccessful, it is handled.
0.5.1 - 2019-10-24 [YANKED]¶
This release was replaced by 0.5.2 due to importing
MachineReadableFormatError
, which is not a backwards-compatible change.
0.5.0 - 2019-08-29¶
Added¶
TeX and ML comment styles added.
Added
--year
and--exclude-year
toreuse addheader
.Added
--template
toreuse addheader
.Added
--explicit-license
toreuse addheader
.binaryornot
added as new dependency.Greatly improved the usage documentation.
Changed¶
reuse addheader
now automatically adds the current year to the copyright notice.reuse addheader
preserves the original header below the new header if it did not contain any SPDX information.reuse addheader
now correctly handles.license
files.Bad licenses are no longer resolved to LicenseRef-Unknown
. They are instead resolved to the stem of the path. This reduces the magic in the code base. .gitkeep
files are now ignored by the tool.Changed Lisp’s comment character from ‘;;’ to ‘;’.
0.4.1 - 2019-08-07¶
Added¶
--all
argument help toreuse download
, which downloads all detected missing licenses.
Fixed¶
When using
reuse addheader
on a file that contains a shebang, the shebang is preserved.Copyright lines in
reuse spdx
are now sorted.Some publicly visible TODOs were patched away.
0.4.0 - 2019-08-07¶
This release is a major overhaul and refactoring of the tool. Its primary focus is improved usability and speed, as well as adhering to version 3.0 of the REUSE Specification.
Added¶
reuse addheader
has been added as a way to automatically add copyright statements and license identifiers to the headers of files. It is currently not complete.reuse init
has been added as a way to initialise a REUSE project. Its functionality is currently scarce, but should improve in the future.
Changed¶
reuse lint
now provides a helpful summary instead of merely spitting out non-compliant files.reuse compile
is nowreuse spdx
.In addition to
Copyright
and©
, copyright lines can be marked with the tagSPDX-FileCopyrightText:
. This is the new recommended default.Project no longer depends on pygit2.
The list of SPDX licenses has been updated.
Valid-License-Identifier
is no longer used, and licenses and exceptions can now only live inside of the LICENSES/ directory.
Removed¶
Removed
--ignore-debian
.Removed
--spdx-mandatory
,--copyright-mandatory
,--ignore-missing
arguments fromreuse lint
.Remove
reuse license
.GPL-3.0 and GPL-3.0+ (and all other similar GPL licenses) are no longer detected as SPDX identifiers. Use GPL-3.0-only and GPL-3.0-or-later instead.
Fixed¶
Scanning a Git directory is a lot faster now.
Scanning binary files is a lot faster now.
0.3.4 - 2019-04-15¶
This release should be a short-lived one. A new (slightly backwards-incompatible) version is in the works.
Added¶
Copyrights can now start with
©
in addition toCopyright
. The former is now recommended, but they are functionally similar.
Changed¶
The source code of reuse is now formatted with black.
The repository has been moved from https://git.fsfe.org/reuse/reuse to https://gitlab.com/reuse/reuse.
0.3.1 - 2018-07-14¶
Fixed¶
When using reuse from a child directory using pygit2, correctly find the root.
0.3.0 - 2018-05-16¶
Changed¶
The output of
reuse compile
is now deterministic. The files, copyright lines and SPDX expressions are sorted alphabetically.
Fixed¶
When a GPL license could not be found, the correct
-only
or-or-later
extension is now used in the warning message, rather than a bareGPL-3.0
.If you have a license listed as
SPDX-Valid-License: GPL-3.0-or-later
, this now correctly matches corresponding SPDX identifiers. Still it is recommended to useSPDX-Valid-License: GPL-3.0
instead.
0.2.0 - 2018-04-17¶
Added¶
Internationalisation support added. Initial support for:
English.
Dutch.
Esperanto.
Spanish.
Fixed¶
The license list of SPDX 3.0 has deprecated
GPL-3.0
andGPL-3.0+
et al in favour ofGPL-3.0-only
andGPL-3.0-or-later
. The program has been amended to accommodate sufficiently for those licenses.
Changed¶
Project.reuse_info_of
now extracts, combines and returns information both from the file itself and from debian/copyright.ReuseInfo
now holds sets instead of lists.As a result of this,
ReuseInfo
will not hold duplicates of copyright lines or SPDX expressions.
click removed as dependency. Good old argparse from the library is used instead.
0.1.1 - 2017-12-14¶
Changed¶
The
reuse --help
text has been tidied up a little bit.
Fixed¶
Release date in change log fixed.
The PyPI homepage now gets reStructuredText instead of Markdown.
0.1.0 - 2017-12-14¶
Added¶
Successfully parse old-style C and HTML comments now.
Added
reuse compile
, which creates an SPDX bill of materials.Added
--ignore-missing
toreuse lint
.Allow to specify multiple paths to
reuse lint
.chardet
added as dependency.pygit2
added as soft dependency. reuse remains usable without it, but the performance withpygit2
is significantly better. Becausepygit2
has a non-Python dependency (libgit2
), it must be installed independently by the user. In the future, when reuse is packaged natively, this will not be an issue.
Changed¶
Updated to version 2.0 of the REUSE recommendations. The most important change is that
License-Filename
is no longer used. Instead, the filename is deducted fromSPDX-License-Identifier
. This change is NOT backwards compatible.The conditions for linting have changed. A file is now non-compliant when:
The license associated with the file could not be found.
There is no SPDX expression associated with the file.
There is no copyright notice associated with the file.
Only read the first 4 KiB (by default) from code files rather than the entire file when searching for SPDX tags. This speeds up the tool a bit.
Project.reuse_info_of
no longer raises an exception. Instead, it returns an emptyReuseInfo
object when no reuse information is found.Logging is a lot prettier now. Only output entries from the
reuse
module.
Fixed¶
reuse --ignore-debian compile
now works as expected.The tool no longer breaks when reading a file that has a non-UTF-8 encoding. Instead,
chardet
is used to detect the encoding before reading the file. If a file still has errors during decoding, those errors are silently ignored and replaced.
0.0.4 - 2017-11-06¶
Fixed¶
Removed dependency on
os.PathLike
so that Python 3.5 is actually supported
0.0.2 - 2017-11-03¶
This is a very early development release aimed at distributing the program as soon as possible. Because this is the first release, the changelog is a little empty beyond “created the program”.
The program can do roughly the following:
Detect the license of a given file through one of three methods (in order of precedence):
Information embedded in the .license file.
Information embedded in its header.
Information from the global debian/copyright file.
Find and report all files in a project tree of which the license could not be found.
Ignore files ignored by Git.
Do some logging into STDERR.
reuse¶
reuse package¶
Submodules¶
reuse.download module¶
Functions for downloading license files from spdx/license-data-list.
-
reuse.download.
download_license
(spdx_identifier)[source]¶ Download the license text from the SPDX repository.
-
reuse.download.
put_license_in_file
(spdx_identifier, destination)[source]¶ Download a license and put it in the destination file.
This function exists solely for convenience.
- Parameters
- Raises
requests.RequestException – if the license could not be downloaded.
FileExistsError – if the license file already exists.
- Return type
None
reuse.header module¶
Functions for manipulating the comment headers of files.
-
exception
reuse.header.
MissingSpdxInfo
[source]¶ Bases:
Exception
Some SPDX information is missing from the result.
-
reuse.header.
create_header
(spdx_info, header=None, template=None, template_is_commented=False, style=None, force_multi=False)[source]¶ Create a header containing spdx_info. header is an optional argument containing a header which should be modified to include spdx_info. If header is not given, a brand new header is created.
template, template_is_commented, and style determine what the header will look like, and whether it will be commented or not.
- Raises
CommentCreateError – if a comment could not be created.
MissingSpdxInfo – if the generated comment is missing SPDX information.
- Return type
-
reuse.header.
find_and_replace_header
(text, spdx_info, template=None, template_is_commented=False, style=None, force_multi=False)[source]¶ Find the first SPDX comment block in text. That comment block is replaced by a new comment block containing spdx_info. It is formatted as according to template. The template is normally uncommented, but if it is already commented, template_is_commented should be
True
.If both style and template_is_commented are provided, style is only used to find the header comment.
If the comment block already contained some SPDX information, that information is merged into spdx_info.
If no header exists, one is simply created.
text is returned with a new header.
- Raises
CommentCreateError – if a comment could not be created.
MissingSpdxInfo – if the generated comment is missing SPDX information.
- Return type
reuse.init module¶
Functions for REUSE-ifying a project.
reuse.lint module¶
All linting happens here. The linting here is nothing more than reading the reports and printing some conclusions.
-
reuse.lint.
lint
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Lint the entire project.
- Return type
-
reuse.lint.
lint_bad_licenses
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Lint for bad licenses. Bad licenses are licenses that are not in the SPDX License List or do not start with LicenseRef-.
-
reuse.lint.
lint_deprecated_licenses
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Lint for deprecated licenses.
-
reuse.lint.
lint_files_without_copyright_and_licensing
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Lint for files that do not have copyright or licensing information.
-
reuse.lint.
lint_licenses_without_extension
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Lint for licenses without extensions.
-
reuse.lint.
lint_missing_licenses
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Lint for missing licenses. A license is missing when it is referenced in a file, but cannot be found.
-
reuse.lint.
lint_read_errors
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Lint for read errors.
-
reuse.lint.
lint_summary
(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)[source]¶ Print a summary for linting.
- Return type
None
reuse.project module¶
Module that contains the central Project class.
-
class
reuse.project.
Project
(root, include_submodules=False)[source]¶ Bases:
object
Simple object that holds the project’s root, which is necessary for many interactions.
-
all_files
(directory=None)[source]¶ Yield all files in directory and its subdirectories.
The files that are not yielded are:
Files ignored by VCS (e.g., see .gitignore)
Files/directories matching IGNORE_*_PATTERNS.
-
reuse.report module¶
Module that contains reports about files and projects for linting.
-
class
reuse.report.
FileReport
(name, path, do_checksum=True)[source]¶ Bases:
object
Object that holds a linting report about a single file. Importantly, it also contains SPDX File information in
spdxfile
.
-
class
reuse.report.
ProjectReport
(do_checksum=True)[source]¶ Bases:
object
Object that holds linting report about the project.
-
bill_of_materials
()[source]¶ Generate a bill of materials from the project.
See https://spdx.org/specifications.
- Return type
-
property
files_without_copyright
¶ Iterable of paths that have no copyright information.
-
property
files_without_licenses
¶ Iterable of paths that have no license information.
-
classmethod
generate
(project, do_checksum=True, multiprocessing=True)[source]¶ Generate a ProjectReport from a Project.
- Return type
-
property
unused_licenses
¶ Set of license identifiers that are not found in any file report.
-
reuse.spdx module¶
Compilation of the SPDX Document.
reuse.vcs module¶
This module deals with version control systems.
-
class
reuse.vcs.
VCSStrategy
(project)[source]¶ Bases:
abc.ABC
Strategy pattern for version control systems.
-
abstract classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
abstract classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
abstract classmethod
-
class
reuse.vcs.
VCSStrategyGit
(project)[source]¶ Bases:
reuse.vcs.VCSStrategy
Strategy that is used for Git.
-
classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
-
class
reuse.vcs.
VCSStrategyHg
(project)[source]¶ Bases:
reuse.vcs.VCSStrategy
Strategy that is used for Mercurial.
-
classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
-
class
reuse.vcs.
VCSStrategyNone
(project)[source]¶ Bases:
reuse.vcs.VCSStrategy
Strategy that is used when there is no VCS.
-
classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
-
reuse.vcs.
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
Module contents¶
reuse is a tool for compliance with the REUSE recommendations.
-
exception
reuse.
IdentifierNotFound
[source]¶ Bases:
reuse.ReuseException
Could not find SPDX identifier for license file.