Skip to content
The tool for checking and helping with compliance with the REUSE Initiative recommendations
Branch: master
Clone or download
Latest commit f672c1f May 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.reuse Do a massive refactoring Apr 16, 2019
LICENSES Do a massive refactoring Apr 16, 2019
docs Do a massive refactoring Apr 16, 2019
po Move the compilation of .mo files into setup.py Apr 17, 2019
src/reuse Add pathType to lint May 21, 2019
tests Fix error May 22, 2019
.bumpversion.cfg Do a massive refactoring Apr 16, 2019
.editorconfig Do a massive refactoring Apr 16, 2019
.gitignore Do a massive refactoring Apr 16, 2019
.gitlab-ci.yml Update tox.ini May 14, 2019
.pre-commit-config.yaml
.pylintrc Parallelise pylint May 21, 2019
AUTHORS.rst Do a massive refactoring Apr 16, 2019
CHANGELOG.rst Do a massive refactoring Apr 16, 2019
MANIFEST.in Exclude .mo files from MANIFEST Apr 17, 2019
Makefile Get rid of doctest to fix part of the issue May 14, 2019
README.rst Fix old references to Python 3.5 May 14, 2019
pyproject.toml Do a massive refactoring Apr 16, 2019
requirements.txt Add a method to download licenses May 9, 2019
setup.py Merge branch 'master' into download May 15, 2019
tox.ini xfail some tests that fail in CI May 21, 2019

README.rst

reuse

license version python reuse standard-readme status

reuse is a tool for compliance with the REUSE Initiative recommendations.

Background

Copyright and licensing is difficult, especially when reusing software from different projects that are released under various different licenses. The REUSE Initiative was started by the 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:

  1. Provide the exact text of each license used, verbatim.
  2. Include a copyright notice and license in (or about) each file.
  3. Provide an inventory for included software.

You are recommended to read the recommendations in full for more details.

This tool exists to facilitate the developer in complying to the above recommendations.

There are other tools, such as FOSSology, that have a lot more features and functionality surrounding the analysis and inspection of copyright and licenses in software projects. reuse, on the other hand, is solely designed to be a simple tool to assist in compliance with the REUSE Initiative recommendations.

Install

To install reuse, you need to have the following pieces of software on your computer:

  • Python 3.6+
  • Pip

To install reuse, you only need to run the following command:

pip3 install --user fsfe-reuse

After this, make sure that ~/.local/bin is in your $PATH.

Usage

First, read the REUSE recommendations. In a nutshell:

  • Include the texts of all used licenses in your project.
  • Add a comment header to each file that says SPDX-License-Identifier: GPL-3.0-or-later.
  • Add a comment header to each file that says SPDX-Copyright: YEAR NAME. You can be flexible with the format, just make sure that the line starts with SPDX-Copyright:.

Once you have taken those steps (again, read the actual recommendations for better instructions), you can use this tool to verify whether your project is fully compliant with the REUSE recommendations. To check against the recommendations, use reuse lint:

~/Projects/reuse-tool $ reuse lint
[...]
Congratulations! Your project is REUSE compliant :-)

Maintainers

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 contact@fsfe.org.

Starting local development is very simple, just execute the following commands:

git clone git@github.com:fsfe/reuse-tool.git
cd reuse/
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

Copyright (C) 2017-2019 Free Software Foundation Europe e.V.

Licensed under the GNU General Public License version 3 or later.

You can’t perform that action at this time.