Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate nice licensing page #962

Open
niccokunzmann opened this issue Apr 22, 2024 · 1 comment
Open

Generate nice licensing page #962

niccokunzmann opened this issue Apr 22, 2024 · 1 comment
Labels
enhancement New feature or request priority/low Low priority

Comments

@niccokunzmann
Copy link

For another project, I was using flutter and it has this nice license overview:

grafik

I was wondering it there is a way to easily generate a licensing page from the reuse annotations of my repository. Is there a tool that can do that?

When I see this: https://reuse.readthedocs.io/en/stable/readme.html#license
Then, I wonder if you would like use a tool like that yourself.


Which API can I use to get all the licensing information e.g. in a JSON format?
Answered:

reuse lint --json

I think, I would like something like this:

reuse lint --html

That outputs an HTML page.

@carmenbianca
Copy link
Member

I'm not sure we should output HTML—everyone will want something different. However, a decently formatted plain-text output wouldn't be a bad idea. We could call this reuse credits, which will reproduce:

This generated text might come in handy for certain compliance processes.

I'm not sure if the copyright notices should be categorised by licence, or if that would even make sense. Furthermore, reproducing all licence texts may not make sense for projects that 'collapse' to a single licence (usually GPLv2 or GPLv3).

This will need some brainstorming before implementation.

Thanks @niccokunzmann for opening the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority/low Low priority
Projects
None yet
Development

No branches or pull requests

2 participants