reuse-shortcuts 1.0.0

Shortcuts Management for reuse license utility

Reuse Shortcut Management

Shortcuts Management for reuse license utility

Installation

Install this package in a dedicated python environment via

python -m venv venv
source venv/bin/activate
pip install reuse-shortcuts

To use this in a development setup, clone the source code from gitlab, start the development server and make your changes::

git clone https://codebase.helmholtz.cloud/hcdc/reuse-shortcuts
cd reuse-shortcuts
python -m venv venv
source venv/bin/activate
make dev-install

More detailed installation instructions my be found in the docs.

Usage

Installing this package provides you with a reuse-shortcuts CLI executable. When using this command in a repository, it will look for a file named .reuse/shortcuts.yaml in the root of the repository. This file is supposed to have the following format:

<key>:
  copyrights: []
  years: []
  licenses: []

where copyrights, years and licenses are what you would usually add with reuse annotate --year <year> --copyright <copyright> --license <license [further options], and <key> is an identifier you define yourself.

Instead of calling the very verbose reuse annotate [...] [further options] command, you can just run reuse-shortcuts <key> [further options] with the <key> you defined in the shortcuts.yaml file.

More detailed usage instructions may be found in the usage docs.

Technical note

This package has been generated from the template https://codebase.helmholtz.cloud/hcdc/software-templates/python-package-template.git.

See the template repository for instructions on how to update the skeleton for this package.

License information

Copyright © 2025 Helmholtz-Zentrum hereon GmbH

Code files in this repository are licensed under the GPL-3.0-or-later, if not stated otherwise in the file.

Documentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.

Supplementary and configuration files in this repository are licensed under CC0-1.0, if not stated otherwise in the file.

Please check the header of the individual files for more detailed information.

License management

License management is handled with reuse. If you have any questions on this, please have a look into the contributing guide or contact the maintainers of reuse-shortcuts.