Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoijui/reuseify
A tool to generate REUSE compatible SPDX licensing info for a project stored in a git repo, using its git commit history for extracting author/copyright info, and a file with assigning regexes matchign the (git tracked/content) files to SPDX expressions.
https://github.com/hoijui/reuseify
generator reuse spdx
Last synced: about 1 month ago
JSON representation
A tool to generate REUSE compatible SPDX licensing info for a project stored in a git repo, using its git commit history for extracting author/copyright info, and a file with assigning regexes matchign the (git tracked/content) files to SPDX expressions.
- Host: GitHub
- URL: https://github.com/hoijui/reuseify
- Owner: hoijui
- License: agpl-3.0
- Created: 2023-03-28T14:08:39.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-29T05:29:40.000Z (about 1 year ago)
- Last Synced: 2024-06-13T22:05:14.653Z (5 months ago)
- Topics: generator, reuse, spdx
- Language: Shell
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# REUSE-ify
[](
https://spdx.org/licenses/AGPL-3.0-or-later.html)
[](
https://api.reuse.software/info/github.com/hoijui/reuseify)
A BASH (and AWK) tool to generate [REUSE] compatible
SPDX licensing info for a project stored in a git repo.
## How it works
It assigns to the projects files:
* **author/copyright** info,
by extracting it from the git commit history
* **licenses**, using regex + SPDX expression pairs
defined in a file
The grunt work is done with the [REUSE tool] under the hood.
This tool does not let you execute and forget! \
In any case, you **have to manually adjust**
whatever this script generates!
## Why / What for
[REUSE] is a system by the [Free Software Foundation Europe],
for assigning detailed (per file) licensing information for a project,
both human- and machine-readable.
In other words, it is like your *LICENSE* file on steroids.
There are many good reasons to do this, but we will assume now,
that you are already convinced it is a good idea to have that.
If you start a new project, you can add REUSE info to it from the start.
If you want to convert an existing project however,
things are a bit more difficult:
There are a lot of files already,
probably edited by many people over years,
sometimes renamed or moved to different directories, ...
How to handle this; how to correctly annotate each file now?
This is where this project comes in.
Instead of manually extracting the list of authors for each file
and the years they were active,
plus deciding on the license for each file,
this script helps you automate as much of this as possible. \
Always remember though,
that this only relieves you of the labor-intensive grit-work,
and not of any legal questions or from **manually checking
if the generated info actually makes sense**.
## Installation
You first need to install the original [REUSE tool] by the FSF,
if you don't already have it. \
Then you may continue installing the latest version of reusify:
```sh
git clone "https://github.com/hoijui/reuseify.git"
cd "reuseify/src/software"
# BASH: for new sessions
echo "export PATH=\"$PATH:$(pwd)\"" > ~/.profile
# BASH: for this session
export PATH="$PATH:$(pwd)"
# fish: for this session, all others and after reboot
#fish_add_path (pwd)
```
to update:
```sh
cd reuseify
git pull
```
## Usage
```sh
cd my-git-project
reuseify.sh --init
# Manually edit file '.reuseify/license_rgxs.tsv'.
reuseify.sh
# Amend the created git commit with your favorite IDE or git GUI.
```
**IMPORTANT** \
If successful, this tool generates a git commit with all the changes,
which you **will have to manually edit** (aka amend)! \
See the next section for an explanation of this commit.
**NOTE** \
It can also be used on already partially annotated projects.
## What it does
It creates a new git commit, that contains:
1. All files that were without REUSE info, should now have it annotated.
2. Those that support header comments, will have it there.
3. Those who do not support header comments,
will have it duplicated to two locations -
`${file_path}.license` and `.reuse/dep5` -
and it is crucial to edit this,
and make sure it remains only in one of the two,
and in a cleaned up way,
especially if you decide to use `.reuse/dep5`,
you might want to unify entries with clever usage of globs,
without over-using them.
You can choose which location to use on a per-file basis.
We do the duplication of annotations described in step 3. above,
to leave ones options open,
and consequently minimizing the required manual work,
to get to what one wants,
basically reducing the required manual work to just deletions.
[REUSE]: https://reuse.software/
[REUSE tool]: https://git.fsfe.org/reuse/tool
[Free Software Foundation Europe]: https://fsfe.org/