https://github.com/akullpp/foss

Scans GitHub repositories for their license.
https://github.com/akullpp/foss

Last synced: about 2 months ago
JSON representation

Scans GitHub repositories for their license.

• Host: GitHub
• URL: https://github.com/akullpp/foss
• Owner: akullpp
• License: mit
• Created: 2019-10-04T09:47:21.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-05T22:23:07.000Z (over 2 years ago)
• Last Synced: 2025-01-16T16:42:50.651Z (over 1 year ago)
• Language: Java
• Homepage: https://chrysanthium.com
• Size: 61.5 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# FOSS Scanner [![Build Status](https://travis-ci.com/akullpp/foss.svg?branch=master)](https://travis-ci.com/akullpp/foss)

The FOSS Scanner is used to extract GitHub repositories from a README via the v3 API and check their licenses.

## Configuration

Configuration is done in the `.env` file.

Please use your own `FOSS_GITHUB_OAUTH2_TOKEN` as described [here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).

There are no privileges required for the token.

Currently by default the README from [akullpp/awesome-java](https://github.com/akullpp/awesome-java) is parsed, you can change the parsed README by setting `FOSS_ROOT_OWNER` and `FOSS_ROOT_REPOSITORY` environment variables, either in `.env` or the system.

Other environment variables are:

* `FOSS_GITHUB_URL_PATTERN`: The pattern of Github URLs

* `FOSS_GITHUB_OWNER_REPOSITORIES_PATTERN`: The pattern of GitHub URLs for repositories

* `FOSS_OWNER_BLACKLIST`: Comma-denoted blacklist of repository owners.

## Usage

```sh

./mvnw clean package

java -jar target/foss-*-with-dependencies.jar

```