The tool for checking and helping with compliance with the REUSE Initiative recommendations https://reuse.software
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
carmenbianca adf5be2d9e
Merge remote-tracking branch 'origin/master'
1 dag geleden
.reuse Make the source tarball REUSE-compliant 5 maanden geleden
LICENSES Do a massive refactoring 7 maanden geleden
docs Update example 1 dag geleden
po Fix create-pot 3 maanden geleden
src/reuse Merge remote-tracking branch 'origin/master' 1 dag geleden
tests Update requirements.txt 1 dag geleden
.bumpversion.cfg Bump version: 0.5.2 → 0.6.0 1 dag geleden
.editorconfig Add usage documentation for addheader 2 maanden geleden
.gitignore Use SPDX-FileCopyrightText instead of SPDX-Copyright 3 maanden geleden
.gitlab-ci.yml Use SPDX-FileCopyrightText instead of SPDX-Copyright 3 maanden geleden
.pre-commit-config.yaml Use SPDX-FileCopyrightText instead of SPDX-Copyright 3 maanden geleden
.pylintrc Disable pylint duplicate-code 3 maanden geleden
AUTHORS.rst Add Kirill as contributor 3 weken geleden
CHANGELOG.md Merge branch 'master' into deprecated 1 dag geleden
Dockerfile Use SPDX-FileCopyrightText instead of SPDX-Copyright 3 maanden geleden
MANIFEST.in Use SPDX-FileCopyrightText instead of SPDX-Copyright 3 maanden geleden
Makefile Fix create-pot 3 maanden geleden
README.md use dynamically created compliance badge 3 weken geleden
pyproject.toml Use SPDX-FileCopyrightText instead of SPDX-Copyright 3 maanden geleden
requirements.txt Update requirements.txt 1 dag geleden
setup.py Bump version: 0.5.2 → 0.6.0 1 dag geleden
tox.ini Use SPDX-FileCopyrightText instead of SPDX-Copyright 3 maanden geleden

README.md

reuse

REUSE status

reuse is a tool for compliance with the REUSE recommendations.

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:

  1. Choose and provide licenses
  2. Add copyright and licensing information to each file
  3. 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.

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 fsfe-reuse

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

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:

  1. Put your licenses in the LICENSES/ directory.
  2. Add a comment header to each file that says SPDX-License-Identifier: GPL-3.0-or-later, and SPDX-FileCopyrightText: $YEAR $NAME. You can be flexible with the format, just make sure that the line starts with SPDX-FileCopyrightText:.
  3. Verify your work using this tool.

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 the LICENSES/ 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

REUSE is simple to include 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, or GitLab CI.

Within the fsfe/reuse Docker image available on Docker Hub, you can run the helper tool simply by executing reuse lint. To use the tool on your computer, you can mount your project directory and run reuse lint <path/to/directory>.

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

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

Copyright © 2017-2019 Free Software Foundation Europe e.V.

This work is licensed under multiple licences. Because keeping this section up-to-date is challenging, here is a brief summary as of July 2019:

  • 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.