reuse
/
api
10
3
Fork 2
Code Issues 9 Pull Requests 6 Releases Wiki Activity
API for checking REUSE compliance of a git project https://api.reuse.software
239 Commits 8 Branches 0 Tags 5.3 MiB
Python 53.3%
HTML 32.9%
Makefile 6.5%
CSS 4.7%
Dockerfile 2.6%
Go to file
Linus Sehn 6426ba31ee
continuous-integration/drone/push Build is passing Details
chore: bump api-worker 		2023-11-04 12:10:44 +01:00
.reuse Make HTML pages look better (#26) 2019-09-03 12:29:05 +02:00
LICENSES fix REUSE compliance 2021-06-15 13:49:45 +02:00
api-worker@6c9c7f29da chore: bump api-worker 2023-11-04 12:10:44 +01:00
doc Add Admin API documentation for `project_by_status` 2023-06-17 12:12:03 +02:00
forms@a0c1edd3e4 dev: some more changes and unifications of compose 2022-12-03 16:12:44 +01:00
reuse_api make badge compliant color the de-facto default green 2023-08-08 15:46:14 +02:00
tests Set correct `SQLALCHEMY_DATABASE_URI` 2022-11-24 13:20:02 +01:00
.dockerignore Add unittests, bump quality check versions (#50) 2022-02-18 15:47:22 +00:00
.drone.yml add URL to force a re-check of a repo, given the valid admin key is provided 2023-03-29 16:44:58 +02:00
.gitignore make psql database persistent 2022-12-03 18:19:26 +01:00
.gitmodules Change submodule URL to use HTTPS rather than SSH 2021-09-28 15:43:35 +01:00
.gitmodules.license Allow to run full API locally (#39) 2020-11-16 08:57:13 +00:00
Dockerfile Run API with four worker processes 2022-12-04 09:57:15 +01:00
MANIFEST.in Replace SPDX-Copyright with SPDX-FileCopyrightText 2019-08-28 10:41:34 +02:00
Makefile dev: actually build images 2022-12-04 00:14:41 +01:00
Pipfile Bump packages 2022-11-24 12:52:01 +01:00
Pipfile.lock (chore) Bump dependencies 2022-12-04 10:33:26 +01:00
Pipfile.lock.license Make compliant 2019-08-28 10:47:55 +02:00
README.md Verbose README, delete plan 2019-09-04 12:38:51 +02:00
docker-compose.dev.yml add URL to force a re-check of a repo, given the valid admin key is provided 2023-03-29 16:44:58 +02:00
docker-compose.quality.yml Set default instead of env var 2022-11-24 13:43:21 +01:00
docker-compose.yml add URL to force a re-check of a repo, given the valid admin key is provided 2023-03-29 16:44:58 +02:00
pyproject.toml fix isort deprecation warning 2022-02-23 11:52:48 +01:00
renovate.json Try again 2022-10-26 14:33:28 +02:00
renovate.json.license make REUSE compliant 2021-06-10 16:53:48 +02:00
setup.py fix 'Package would be ignored' errors 2022-08-18 16:48:57 +02:00

README.md

REUSE API

Build Status REUSE compliant

The REUSE API checks repositories for their compliance with the REUSE best practices. It basically runs the lint command of the REUSE helper tool for the default branch of a project.

REUSE offers many tools and methods to support developers in making their licensing more clear and simple. This API is an additional component and enables other users to see a project's REUSE status transparently.

This repository contains the web part for all user interaction. The parts needed for the external server performing the checks are hosted in the api-worker repository.

This service is accessible via api.reuse.software, but interested users can set up their own instance.

Features

  • Users can register any public Git repository with this API.
  • The API runs the linter on each registered project.
  • Re-check projects if they have been updated (new commit).
  • Informative information page for each registered project.
  • Offer a live badge indicating the REUSE compliance status.
  • Offer a JSON for parsing the current REUSE status.

Background

Copyright and licensing is difficult, especially when reusing software from different projects that are released under various different licenses. REUSE was started by the Free Software Foundation Europe (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.

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 the recommendations in full for more details.

Install

Please refer to the /doc directory of this project for information on how to install and configure the REUSE API.

Maintainers

Contribute

Any pull requests or suggestions are welcome at https://git.fsfe.org/reuse/api or via e-mail to one of the maintainers. General inquiries can be sent to the REUSE mailing list.

Information on how to develop and hack around with this project can be found in the file /doc/hack.md.

License

Copyright (C) 2019 Free Software Foundation Europe e.V.

This work is licensed under multiple licences. Because keeping this section up-to-date is challenging, here is a brief summary as of September 2019:

  • All original source code is licensed under GPL-3.0-or-later.
  • All documentation and most graphical files are licensed under CC-BY-SA-4.0.
  • Some borrowed HTML code from the REUSE website is licenses under MIT.
  • Other external web elements like libraries and fonts are licenses under Apache-2.0, MIT, OFL-1.1.
  • Most configuration files are licenses under CC0-1.0.

For more accurate information, check the individual files.