reuse_shortcuts package

Reuse Shortcut Management

Shortcuts Management for reuse license utility

This script can be used to apply the licenses and default copyright holders to files in the repository.

It uses the short cuts from the .reuse/shortcuts.yaml file in the current project root and adds them to the call of reuse annotate. Any command line option however overwrites the config in shortcuts.yaml

Classes:

LicenseShortCut

Shortcut to add a copyright statement

Functions:

add_annotate_arguments(command)
load_shortcuts(project)	Load the shortcuts.yaml file.

class reuse_shortcuts.LicenseShortCut

Bases: TypedDict

Shortcut to add a copyright statement

Attributes:

copyrights	The copyright statement
licenses	SPDX Identifier of the license
years	year of copyright statement

copyrights: List[str] | None

The copyright statement

licenses: List[str] | None

SPDX Identifier of the license

years: List[str] | None

year of copyright statement

reuse_shortcuts.add_annotate_arguments(command)

reuse_shortcuts.load_shortcuts(project: Path) → Dict[str, LicenseShortCut]

Load the shortcuts.yaml file.