<!--
SPDX-FileCopyrightText: 2017 Free Software Foundation Europe e.V. <https://fsfe.org>
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# reuse
[](https://pypi.python.org/pypi/reuse)
[](https://pypi.python.org/pypi/reuse)
[](https://api.reuse.software/info/github.com/fsfe/reuse-tool)
[](https://github.com/RichardLitt/standard-readme)
[](https://repology.org/project/reuse/versions)
[](https://hosted.weblate.org/projects/fsfe/reuse-tool/)
reuse is a tool for compliance with the [REUSE](https://reuse.software/)
recommendations.
- Documentation: <https://reuse.readthedocs.io> and <https://reuse.software>
- Source code: <https://github.com/fsfe/reuse-tool>
- PyPI: <https://pypi.python.org/pypi/reuse>
- REUSE: 3.3
- Python: 3.9+
## Table of contents
- [Background](#background)
- [Install](#install)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [Licensing](#licensing)
## Background
<!-- REUSE-IgnoreStart -->
Copyright and licensing is difficult, especially when reusing software from
different projects that are released under various different licenses.
[REUSE](https://reuse.software) was started by the
[Free Software Foundation Europe](https://fsfe.org) (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.
<!-- REUSE-IgnoreEnd -->
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](https://reuse.software/tutorial) for
a step-by-step guide through these three steps. The
[FAQ](https://reuse.software/faq) covers basic questions about licensing,
copyright, and more complex use cases. Advanced users and integrators will find
the [full specification](https://reuse.software/spec) helpful.
This tool exists to facilitate the developer in complying with the above
recommendations.
There are [other tools](https://reuse.software/comparison) 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 package manager (Recommended)
There are packages available for easy install on many operating systems. You are
welcome to help us package this tool for more distributions!
An automatically generated list can be found at
[repology.org](https://repology.org/project/reuse/versions), without any
guarantee for completeness.
### Install and run via pipx (Recommended)
The following one-liner both installs and runs this tool from
[PyPI](https://pypi.org/project/reuse/) via
[pipx](https://pypa.github.io/pipx/):
```bash
pipx run reuse lint
```
pipx automatically isolates reuse into its own Python virtualenv, which means
that it won't interfere with other Python packages, and other Python packages
won't interfere with it.
If you want to be able to use reuse without prepending it with `pipx run` every
time, install it globally like so:
```bash
pipx install reuse
```
reuse will then be available in `~/.local/bin`, which must be added to your
`$PATH`.
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 upgrade reuse, run this command:
```bash
pipx upgrade reuse
```
For full functionality, the following pieces of software are recommended:
- Git
- Mercurial 4.3+
- Pijul
- Jujutsu
### Installation via pip
To install reuse into `~/.local/bin`, run:
```bash
pip3 install --user reuse
```
Subsequently, make sure that `~/.local/bin` is in your `$PATH` like described in
the previous section.
To upgrade reuse, run this command:
```bash
pip3 install --user --upgrade reuse
```
### 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.
```bash
pip install .
```
## Usage
First, read the [REUSE tutorial](https://reuse.software/tutorial/). In a
nutshell:
<!-- REUSE-IgnoreStart -->
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.
Example of header:
```
# SPDX-FileCopyrightText: 2017 Free Software Foundation Europe e.V. <https://fsfe.org>
#
# SPDX-License-Identifier: CC-BY-SA-4.0
```
<!-- REUSE-IgnoreEnd -->
### CLI
To check against the recommendations, use `reuse lint`:
```
~/Projects/reuse-tool $ reuse lint
[...]
Congratulations! Your project is compliant with version 3.3 of the REUSE Specification :-)
```
This tool can do various more things, detailed in the documentation. Here a
short summary:
- `annotate` --- Add copyright and/or licensing information to the header of a
file.
- `download` --- Download the specified license into the `LICENSES/` directory.
- `lint` --- Verify the project for REUSE compliance.
- `lint-file` --- Verify REUSE compliance of individual files.
- `spdx` --- Generate an SPDX Document of all files in the project.
- `supported-licenses` --- Prints all licenses supported by REUSE.
- `convert-dep5` --- Convert .reuse/dep5 to REUSE.toml.
### Example demo
In this screencast, we are going to follow the
[tutorial](https://reuse.software/tutorial), making the
[REUSE example repository](https://github.com/fsfe/reuse-example/) compliant.
### Run in Docker
The `fsfe/reuse` Docker image is available on
[Docker Hub](https://hub.docker.com/r/fsfe/reuse). 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](https://reuse.software/dev/)
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:
```bash
docker run --rm --volume $(pwd):/data fsfe/reuse lint
```
You can also provide additional arguments, like so:
```bash
docker run --rm --volume $(pwd):/data fsfe/reuse --include-submodules spdx -o out.spdx
```
The available tags are:
- `latest` --- the most recent release of reuse.
- `{major}` --- the latest major release.
- `{major}.{minor}` --- the latest minor release.
- `{major}.{minor}.{patch}` --- a precise release.
You can add `-debian` to any of the tags to get a Debian-based instead of an
Alpine-based image, which is larger, but may be better suited for license
compliance.
### 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](https://pre-commit.com/). Once you
[have it installed](https://pre-commit.com/#install), add this to the
`.pre-commit-config.yaml` in your repository:
```yaml
repos:
- repo: https://github.com/fsfe/reuse-tool
rev: v5.0.2
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.
If you instead want to only lint files that were changed in your commit, you can
use the following configuration:
```yaml
repos:
- repo: https://github.com/fsfe/reuse-tool
rev: v5.0.2
hooks:
- id: reuse-lint-file
```
### Shell completion
In order to enable shell completion, you need to generate the shell completion
script. You do this with `_REUSE_COMPLETE=bash_source reuse`. Replace `bash`
with `zsh` or `fish` as needed, or any other shells supported by the Python
`click` library. You can then source the output in your shell rc file, like so
(e.g.`~/.bashrc`):
```bash
eval "$(_REUSE__COMPLETE=bash_source reuse)"
```
Alternatively, you can place the generated completion script in
`${XDG_DATA_HOME}/bash-completion/completions/reuse`.
## Maintainers
- Carmen Bianca Bakker <carmenbianca@fsfe.org>
### Former maintainers
- Max Mehl <max.mehl@fsfe.org>
- Linus Sehn <linus@fsfe.org>
## Contributing
If you're interested in contributing to the reuse project, there are several
ways to get involved. Development of the project takes place on GitHub at
<https://github.com/fsfe/reuse-tool>. There, you can submit bug reports, feature
requests, and pull requests. Even and especially when in doubt, feel free to
open an issue with a question. Contributions of all types are welcome, and the
development team is happy to provide guidance and support for new contributors.
You should exercise some caution when opening a pull request to make changes
which were not (yet) acknowledged by the team as pertinent. Such pull requests
may be closed, leading to disappointment. To avoid this, please open an issue
first.
Additionally, the <reuse@lists.fsfe.org> mailing list is available for
discussion and support related to the project.
You can find the full contribution guidelines at
<https://reuse.readthedocs.io/en/latest/contribute.html>.
## Licensing
This work is licensed under multiple licences. Because keeping this section
up-to-date is challenging, here is a brief summary as of April 2024:
- 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/tools-python](https://github.com/spdx/tools-python) is licensed under
Apache-2.0.
For more accurate information, check the individual files.
Raw data
{
"_id": null,
"home_page": "https://reuse.software/",
"name": "reuse",
"maintainer": "Carmen Bianca Bakker",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "carmenbianca@fsfe.org",
"keywords": null,
"author": "Free Software Foundation Europe",
"author_email": "contact@fsfe.org",
"download_url": "https://files.pythonhosted.org/packages/08/43/35421efe0e69823787b331362e11cc16bb697cd6f19cbed284d421615f14/reuse-5.0.2.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2017 Free Software Foundation Europe e.V. <https://fsfe.org>\n\nSPDX-License-Identifier: CC-BY-SA-4.0\n-->\n\n# reuse\n\n[](https://pypi.python.org/pypi/reuse)\n[](https://pypi.python.org/pypi/reuse)\n[](https://api.reuse.software/info/github.com/fsfe/reuse-tool)\n[](https://github.com/RichardLitt/standard-readme)\n[](https://repology.org/project/reuse/versions)\n[](https://hosted.weblate.org/projects/fsfe/reuse-tool/)\n\nreuse is a tool for compliance with the [REUSE](https://reuse.software/)\nrecommendations.\n\n- Documentation: <https://reuse.readthedocs.io> and <https://reuse.software>\n- Source code: <https://github.com/fsfe/reuse-tool>\n- PyPI: <https://pypi.python.org/pypi/reuse>\n- REUSE: 3.3\n- Python: 3.9+\n\n## Table of contents\n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Maintainers](#maintainers)\n- [Contributing](#contributing)\n- [Licensing](#licensing)\n\n## Background\n\n<!-- REUSE-IgnoreStart -->\n\nCopyright and licensing is difficult, especially when reusing software from\ndifferent projects that are released under various different licenses.\n[REUSE](https://reuse.software) was started by the\n[Free Software Foundation Europe](https://fsfe.org) (FSFE) to provide a set of\nrecommendations to make licensing your Free Software projects easier. Not only\ndo these recommendations make it easier for you to declare the licenses under\nwhich your works are released, but they also make it easier for a computer to\nunderstand how your project is licensed.\n\n<!-- REUSE-IgnoreEnd -->\n\nAs a short summary, the recommendations are threefold:\n\n1. Choose and provide licenses\n2. Add copyright and licensing information to each file\n3. Confirm REUSE compliance\n\nYou are recommended to read [our tutorial](https://reuse.software/tutorial) for\na step-by-step guide through these three steps. The\n[FAQ](https://reuse.software/faq) covers basic questions about licensing,\ncopyright, and more complex use cases. Advanced users and integrators will find\nthe [full specification](https://reuse.software/spec) helpful.\n\nThis tool exists to facilitate the developer in complying with the above\nrecommendations.\n\nThere are [other tools](https://reuse.software/comparison) that have a lot more\nfeatures and functionality surrounding the analysis and inspection of copyright\nand licenses in software projects. The REUSE helper tool, on the other hand, is\nsolely designed to be a simple tool to assist in compliance with the REUSE\nrecommendations.\n\n## Install\n\n### Installation via package manager (Recommended)\n\nThere are packages available for easy install on many operating systems. You are\nwelcome to help us package this tool for more distributions!\n\nAn automatically generated list can be found at\n[repology.org](https://repology.org/project/reuse/versions), without any\nguarantee for completeness.\n\n### Install and run via pipx (Recommended)\n\nThe following one-liner both installs and runs this tool from\n[PyPI](https://pypi.org/project/reuse/) via\n[pipx](https://pypa.github.io/pipx/):\n\n```bash\npipx run reuse lint\n```\n\npipx automatically isolates reuse into its own Python virtualenv, which means\nthat it won't interfere with other Python packages, and other Python packages\nwon't interfere with it.\n\nIf you want to be able to use reuse without prepending it with `pipx run` every\ntime, install it globally like so:\n\n```bash\npipx install reuse\n```\n\nreuse will then be available in `~/.local/bin`, which must be added to your\n`$PATH`.\n\nAfter this, make sure that `~/.local/bin` is in your `$PATH`. On Windows, the\nrequired path for your environment may look like\n`%USERPROFILE%\\AppData\\Roaming\\Python\\Python39\\Scripts`, depending on the Python\nversion you have installed.\n\nTo upgrade reuse, run this command:\n\n```bash\npipx upgrade reuse\n```\n\nFor full functionality, the following pieces of software are recommended:\n\n- Git\n- Mercurial 4.3+\n- Pijul\n- Jujutsu\n\n### Installation via pip\n\nTo install reuse into `~/.local/bin`, run:\n\n```bash\npip3 install --user reuse\n```\n\nSubsequently, make sure that `~/.local/bin` is in your `$PATH` like described in\nthe previous section.\n\nTo upgrade reuse, run this command:\n\n```bash\npip3 install --user --upgrade reuse\n```\n\n### Installation from source\n\nYou can also install this tool from the source code, but we recommend the\nmethods above for easier and more stable updates. Please make sure the\nrequirements for the installation via pip are present on your machine.\n\n```bash\npip install .\n```\n\n## Usage\n\nFirst, read the [REUSE tutorial](https://reuse.software/tutorial/). In a\nnutshell:\n\n<!-- REUSE-IgnoreStart -->\n\n1. Put your licenses in the `LICENSES/` directory.\n2. Add a comment header to each file that says\n `SPDX-License-Identifier: GPL-3.0-or-later`, and\n `SPDX-FileCopyrightText: $YEAR $NAME`. You can be flexible with the format,\n just make sure that the line starts with `SPDX-FileCopyrightText:`.\n3. Verify your work using this tool.\n\nExample of header:\n\n```\n# SPDX-FileCopyrightText: 2017 Free Software Foundation Europe e.V. <https://fsfe.org>\n#\n# SPDX-License-Identifier: CC-BY-SA-4.0\n```\n\n<!-- REUSE-IgnoreEnd -->\n\n### CLI\n\nTo check against the recommendations, use `reuse lint`:\n\n```\n~/Projects/reuse-tool $ reuse lint\n[...]\n\nCongratulations! Your project is compliant with version 3.3 of the REUSE Specification :-)\n```\n\nThis tool can do various more things, detailed in the documentation. Here a\nshort summary:\n\n- `annotate` --- Add copyright and/or licensing information to the header of a\n file.\n- `download` --- Download the specified license into the `LICENSES/` directory.\n- `lint` --- Verify the project for REUSE compliance.\n- `lint-file` --- Verify REUSE compliance of individual files.\n- `spdx` --- Generate an SPDX Document of all files in the project.\n- `supported-licenses` --- Prints all licenses supported by REUSE.\n- `convert-dep5` --- Convert .reuse/dep5 to REUSE.toml.\n\n### Example demo\n\nIn this screencast, we are going to follow the\n[tutorial](https://reuse.software/tutorial), making the\n[REUSE example repository](https://github.com/fsfe/reuse-example/) compliant.\n\n\n\n### Run in Docker\n\nThe `fsfe/reuse` Docker image is available on\n[Docker Hub](https://hub.docker.com/r/fsfe/reuse). With it, you can easily\ninclude REUSE in CI/CD processes. This way, you can check for REUSE compliance\nfor each build. In our [resources for developers](https://reuse.software/dev/)\nyou can learn how to integrate the REUSE tool in Drone, Travis, GitHub, or\nGitLab CI.\n\nYou can run the helper tool simply by providing the command you want to run\n(e.g., `lint`, `spdx`). The image's working directory is `/data` by default. So\nif you want to lint a project that is in your current working directory, you can\nmount it on the container's `/data` directory, and tell the tool to lint. That\nlooks a little like this:\n\n```bash\ndocker run --rm --volume $(pwd):/data fsfe/reuse lint\n```\n\nYou can also provide additional arguments, like so:\n\n```bash\ndocker run --rm --volume $(pwd):/data fsfe/reuse --include-submodules spdx -o out.spdx\n```\n\nThe available tags are:\n\n- `latest` --- the most recent release of reuse.\n- `{major}` --- the latest major release.\n- `{major}.{minor}` --- the latest minor release.\n- `{major}.{minor}.{patch}` --- a precise release.\n\nYou can add `-debian` to any of the tags to get a Debian-based instead of an\nAlpine-based image, which is larger, but may be better suited for license\ncompliance.\n\n### Run as pre-commit hook\n\nYou can automatically run `reuse lint` on every commit as a pre-commit hook for\nGit. This uses [pre-commit](https://pre-commit.com/). Once you\n[have it installed](https://pre-commit.com/#install), add this to the\n`.pre-commit-config.yaml` in your repository:\n\n```yaml\nrepos:\n - repo: https://github.com/fsfe/reuse-tool\n rev: v5.0.2\n hooks:\n - id: reuse\n```\n\nThen run `pre-commit install`. Now, every time you commit, `reuse lint` is run\nin the background, and will prevent your commit from going through if there was\nan error.\n\nIf you instead want to only lint files that were changed in your commit, you can\nuse the following configuration:\n\n```yaml\nrepos:\n - repo: https://github.com/fsfe/reuse-tool\n rev: v5.0.2\n hooks:\n - id: reuse-lint-file\n```\n\n### Shell completion\n\nIn order to enable shell completion, you need to generate the shell completion\nscript. You do this with `_REUSE_COMPLETE=bash_source reuse`. Replace `bash`\nwith `zsh` or `fish` as needed, or any other shells supported by the Python\n`click` library. You can then source the output in your shell rc file, like so\n(e.g.`~/.bashrc`):\n\n```bash\neval \"$(_REUSE__COMPLETE=bash_source reuse)\"\n```\n\nAlternatively, you can place the generated completion script in\n`${XDG_DATA_HOME}/bash-completion/completions/reuse`.\n\n## Maintainers\n\n- Carmen Bianca Bakker <carmenbianca@fsfe.org>\n\n### Former maintainers\n\n- Max Mehl <max.mehl@fsfe.org>\n- Linus Sehn <linus@fsfe.org>\n\n## Contributing\n\nIf you're interested in contributing to the reuse project, there are several\nways to get involved. Development of the project takes place on GitHub at\n<https://github.com/fsfe/reuse-tool>. There, you can submit bug reports, feature\nrequests, and pull requests. Even and especially when in doubt, feel free to\nopen an issue with a question. Contributions of all types are welcome, and the\ndevelopment team is happy to provide guidance and support for new contributors.\n\nYou should exercise some caution when opening a pull request to make changes\nwhich were not (yet) acknowledged by the team as pertinent. Such pull requests\nmay be closed, leading to disappointment. To avoid this, please open an issue\nfirst.\n\nAdditionally, the <reuse@lists.fsfe.org> mailing list is available for\ndiscussion and support related to the project.\n\nYou can find the full contribution guidelines at\n<https://reuse.readthedocs.io/en/latest/contribute.html>.\n\n## Licensing\n\nThis work is licensed under multiple licences. Because keeping this section\nup-to-date is challenging, here is a brief summary as of April 2024:\n\n- All original source code is licensed under GPL-3.0-or-later.\n- All documentation is licensed under CC-BY-SA-4.0.\n- Some configuration and data files are licensed under CC0-1.0.\n- Some code borrowed from\n [spdx/tools-python](https://github.com/spdx/tools-python) is licensed under\n Apache-2.0.\n\nFor more accurate information, check the individual files.\n",
"bugtrack_url": null,
"license": "Apache-2.0 AND CC0-1.0 AND CC-BY-SA-4.0 AND GPL-3.0-or-later",
"summary": "reuse is a tool for compliance with the REUSE recommendations.",
"version": "5.0.2",
"project_urls": {
"Documentation": "https://reuse.readthedocs.org/",
"Homepage": "https://reuse.software/",
"Repository": "https://github.com/fsfe/reuse-tool"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0a2f73de654df9e7e5f67d742c1d949b5c0c7c1203e84b2272d9e34a91faaf5c",
"md5": "b3103e14bb7fc31c3db95f5a69480b70",
"sha256": "7a680f00324e87a72061677a892d8cbabfddf7adcf7a5376aeeed2d78995bbbb"
},
"downloads": -1,
"filename": "reuse-5.0.2-cp313-cp313-manylinux_2_40_x86_64.whl",
"has_sig": false,
"md5_digest": "b3103e14bb7fc31c3db95f5a69480b70",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": "<4.0,>=3.9",
"size": 184309,
"upload_time": "2024-11-14T09:33:15",
"upload_time_iso_8601": "2024-11-14T09:33:15.047577Z",
"url": "https://files.pythonhosted.org/packages/0a/2f/73de654df9e7e5f67d742c1d949b5c0c7c1203e84b2272d9e34a91faaf5c/reuse-5.0.2-cp313-cp313-manylinux_2_40_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "084335421efe0e69823787b331362e11cc16bb697cd6f19cbed284d421615f14",
"md5": "e5622257d047ab7da1c858f091e51da4",
"sha256": "878016ae5dd29c10bad4606d6676c12a268c12aa9fcfea66403598e16eed085c"
},
"downloads": -1,
"filename": "reuse-5.0.2.tar.gz",
"has_sig": false,
"md5_digest": "e5622257d047ab7da1c858f091e51da4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 358798,
"upload_time": "2024-11-14T09:33:17",
"upload_time_iso_8601": "2024-11-14T09:33:17.512701Z",
"url": "https://files.pythonhosted.org/packages/08/43/35421efe0e69823787b331362e11cc16bb697cd6f19cbed284d421615f14/reuse-5.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 09:33:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fsfe",
"github_project": "reuse-tool",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "reuse"
}
JSON
