reuse is a tool for compliance with the REUSE recommendations.
This release contains a lot of small improvements and changes without anything
big per se. Rather, it is made in advance of a release which will contain a
single feature: REUSE.toml, a
replacement for .reuse/dep5. .reuse/dep5 will still be supported as a
deprecated feature for some time.
That future 3.1 release will have some alpha testing in advance.
download and init. (#697).tcl) (#871).jl) (#815).f90) (#836).bzl) (#870).ld) (#862).s) (#862).empty) (#862).shellcheckrc) (#862)pylintrc) (#862).sld, .sls, .sps) (#875)csingle for Zig (.zig) and Hare (.ha) (#889)annotate on a file with an unrecognised file path, the tool
currently exits early. To automatically create a .license file for
unrecognised files, --fallback-dot-license has been added. (#823, #851,
#853, #859; this took a while to get right.).sl directory as used by Sapling SCM.
(#867).git file as a submodule, it now uses the git command to
detect submodules. This helps detect (quoted from Git man page)
"[repositories] that were cloned independently and later added as a submodule
or old setups", which "have the submodule's git directory inside the submodule
instead of embedded into the superproject's git directory". (#687)--force-dot-license and --skip-unrecognised are now mutually exclusive on
annotate. (#852)-extra Docker images. The openssh-client
package is now in the main image. (#849)dev Docker images. (#849)-debian Docker image is now based off debian:12-slim. It used to be
based on the python:slim image, which used debian:slim under the hood. (#849)--explicit-license. (#851)addheader. (#851)sphinx-autodoc-typehints for documentation. (#772)annotate where --single-line and --multi-line would not
correctly raise an error with an incompatible comment style. (#853)After the yanked 2.0.0 release, we're excited to announce our latest major version packed with new features and improvements! We've expanded our file type recognition, now including Fennel, CommonJS, Qt .pro, .pri, .qrc, .qss, .ui, Textile, Visual Studio Code workspace, Application Resource Bundle, Svelte components, AES encrypted files, Jakarta Server Page, Clang format, Browserslist config, Prettier config and ignored files, Flutter pubspec.lock, .metadata, Terraform and HCL, Typst and more.
We've also added the ability to detect SPDX snippet tags in files and introduced additional license metadata for the Python package. A new --json flag has been added to the lint command, marking the first step towards better integration of REUSE output with other tools.
On the changes front, we've bumped the SPDX license list to v3.21 and made significant updates to our Sphinx documentation. Please note that Python 3.6 and 3.7 support has been dropped in this release.
We've fixed several issues including automatic generation of Sphinx documentation via readthedocs.io and a compatibility issue where reuse could not be installed if gettext is not installed.
This update is all about making your experience better. Enjoy adding copyright and licensing information to your code!
.fnl) (#638).cjs) (#632).pro) (#632).pri) (#755).qrc) (#755).qss) (#755).ui) (#755).textile) (#712).code-workspace) (#747).arb) (#749).svelte).aes) (#758).jsp) (#757).clang-format) (#632).browserslist).prettierrc) and ignored files (.prettierignore)pubspec.lock) (#751).metadata) (#751).tf, tfvars) and HCL (.hcl). (#756).typ)--add-license-concluded, --creator-person, and --creator-organization added to reuse spdx. (#623)Apache-2.0 AND CC0-1.0 AND CC-BY-SA-4.0 AND GPL-3.0-or-later. (#733)--contributor option to annotate. (#669)--json flag to lint command (#654).reuse.ReuseInfo now has copy and union methods. (#759)reuse.ReuseInfo now stores information about the source from which the information was gathered. (#654, #787)--suppress-deprecation to hide (verbose) deprecation warnings. (#778)reuse.SpdxInfo was renamed to reuse.ReuseInfo. It is now a (frozen) dataclass instead of a namedtuple. This is only relevant if you're using reuse as a library in Python. Other functions and methods were similarly renamed. (#669)pkg_resources to determine the installed version of reuse. (#724)Project.reuse_info_of now returns a list of ReuseInfo objects instead of a single one. This is because the source information is now stored alongside the REUSE information. (#787)PendingDeprecationWarning will be shown to the user to make them aware of this. (#778)setuptools. (#724).readthedocs.yaml configuration file (#648)/data directory in Docker containers as safe in Git, preventing errors related to linting Git repositories. (#720).fnl) (#638).cjs) (#632).pro) (#632).pri) (#755).qrc) (#755).qss) (#755).ui) (#755).textile) (#712).code-workspace) (#747).arb) (#749).svelte).aes) (#758).jsp) (#757).clang-format) (#632).browserslist).prettierrc) and ignored files (.prettierignore)pubspec.lock) (#751).metadata) (#751).tf, tfvars) and HCL (.hcl). (#756)--add-license-concluded, --creator-person, and --creator-organization
added to reuse spdx. (#623)Apache-2.0 AND CC0-1.0 AND CC-BY-SA-4.0 AND GPL-3.0-or-later. (#733)--contributor option to annotate. (#669)--json flag to lint command (#654).reuse.ReuseInfo now has copy and union methods. (#759)reuse.SpdxInfo was renamed to reuse.ReuseInfo. It is now a (frozen)
dataclass instead of a namedtuple. This is only relevant if you're using reuse
as a library in Python. (#669)pkg_resources to determine the installed
version of reuse. (#724).license or .reuse/dep5 file) is no longer merged.
(#654)setuptools. (#724).readthedocs.yaml configuration file (#648)/data directory in Docker containers as safe in Git, preventing
errors related to linting Git repositories. (#720)Added support for Python 3.11. (#603)
More file types are recognised:
.kts).aidl).pem)Added comment styles:
.vm, .vtl) (#554).xq(l|m|y|uery|)) (#610)Some special endings are always stripped from copyright and licensing statements (#602):
"> (and variations such as '>, " >, and "/>)] ::
setup.py and replaced it with a Poetry configuration. Maintainers
beware. (#600)lint as an overridable argument. (#574)addheader has been renamed to annotate. The functionality remains the
same. (#550)addheader has been deprecated. It still works, but is now undocumented.
(#550)setup.py. (#600)requests removed; using urllib.request from the standard
library instead. (#600)git submodule add repository path where repository is
a file. A flag was added to explicitly allow this in the test framework.
(#619)<?php (#543).A major release! Do not worry, no breaking changes but a development team (@carmenbianca, @floriansnow, @linozen, @mxmehl and @nicorikken) that is confident enough to declare the REUSE helper tool stable, and a bunch of long-awaited features!
Apart from smaller changes under the hood and typical maintenance tasks, the
main additions are new flags to the addheader subcommand that ease recursive
and automatic operations, the ability to ignore areas of a file that contain
strings that may falsely be detected as copyright or license statements, and the
option to merge copyright lines. The tool now also has better handling of some
edge cases with copyright and license identifiers.
We would like to thank the many contributors to this release, among them @ajinkyapatil8190, @aspiers, @ferdnyc, @Gri-ffin, @hexagonrecursion, @hoijui, @Jakelyst, @Liambeguin, @rex4539, @robinkrahl, @rpavlik, @siiptuo, @thbde and @ventosus.
Extend tool documentation with scripts to help using this tool and automating some steps that are not built into the tool itself. (#500)
Recommendations for installation/run methods: package managers and pipx (#457)
Docker images for AArch64 (#478)
Added the ability to ignore parts of a file when running reuse lint. Simply
add REUSE-IgnoreStart and REUSE-IgnoreEnd as comments and all lines
between the two will be ignored by the next run of reuse lint. (#463)
Meson subprojects are now ignored by default. (#496)
More file types are recognised:
.sbt).vim)Added --skip-existing flag to addheader in order to skip files that
already contain SPDX information. This may be useful for only adding SPDX
information to newly created files. (#480)
Added --recursive flag to addheader. (#469)
Preserve shebang for more script files:
Ignore all SPDX files with their typical formats and extensions. (#494)
Add support for merging copyright lines based on copyright statement, transforming multiple lines with a single year into a single line with a range. (#328)
Use setuptools instead of the deprecated distutils which will be removed
with Python 3.12. (#451)
addheader --explicit-license renamed to --force-dot-license. (#476)
Dockerfiles for reuse-tool are now in a separate subdirectory docker. (#499)
Updated SPDX license list to 3.17. (#513)
The copyright detection mechanism now silently accepts the following strings:
Copyright(c) and Copyright(C). (#440)
--explicit-license in favour of --force-dot-license.
--explicit-license will remain useable (although undocumented) for the
foreseeable future. (#476)JsxCommentStyle in favor of using CCommentStyle directly (see section
Fixed). (#406)Better support for unary "+" operator in license identifiers. For example, if
Apache-1.0+ appears as a declared license, it should not be identified as
missing, bad, or unused if LICENSES/Apache-1.0.txt exists. It is, however,
identified separately as a used license. (#123)
When addheader creates a .license file, that file now has a newline at the
end. (#477)
Cleaned up internal string manipulation. (#477)
JSX (.jxs and .tsx) actually uses C comment syntax as JSX blocks never
stand at the beginning of the file where the licensing info needs to go.
(#406)
Happy holidays! This is mainly a maintenance release fixing some subcommands and
adding loads of supported file types and file names. However, you can also enjoy
the supported-licenses subcommand and the --quiet flag for linting as well
as better suggestions for license identifiers. Thanks to everyone who
contributed!
supported-licenses command that lists all licenses supported by REUSE (#401)
--quiet switch to the lint command (#402)
Better suggestions for faulty SPDX license identifiers in download and
init (#416)
Python 3.10 support declared
More file types are recognised:
.ftl).adoc, .asc, .asciidoc).csl).cc and .hh).graphql).hbs).mdlrc).doc, .xls, .pptx and many more).nim.cfg, .nimble).odt, .ods, .fodp and many more).pod).pdf).proto).soy).sc, .scsyndef).ttl).v, .vsh).vue)More file names are recognised:
Doxyfile).eslintignore and .eslintrc)meson_options.txt).npmignore)Containerfile)archive.sctxar).yarn.lock and .yarnrc)Fix Extensible Stylesheet Language (.xsl) to use HTML comment syntax
Allow creating .license file for write-protected files (#347) (#418)
Do not break XML files special first line (#378)
Make download subcommand work correctly outside of project root and with
--root (#430)