https://github.com/sambacha/spdx-runner

SPDX License check via CI/CLI with expandable dict
https://github.com/sambacha/spdx-runner

bash ethereum foss git grep oss python shell solidity spdx spdx-license-identifier zsh

Last synced: 13 days ago
JSON representation

SPDX License check via CI/CLI with expandable dict

• Host: GitHub
• URL: https://github.com/sambacha/spdx-runner
• Owner: sambacha
• License: other
• Created: 2020-07-31T08:49:30.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-04-16T08:39:50.000Z (over 3 years ago)
• Last Synced: 2024-10-12T15:27:39.662Z (27 days ago)
• Topics: bash, ethereum, foss, git, grep, oss, python, shell, solidity, spdx, spdx-license-identifier, zsh
• Language: Python
• Homepage:
• Size: 195 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SPDX Runner

> CLI/CI Software License check

[![Code Style: Black](https://github.com/sambacha/spdx-runner/actions/workflows/black.yml/badge.svg?branch=master)](https://github.com/sambacha/spdx-runner/actions/workflows/black.yml)

## Overview

Verifies that files include SPDX license headers

Check file extensions have the allowed/acceptable SPDX headers for them.

```

C source: // SPDX-License-Identifier: 

C header: /* SPDX-License-Identifier:  */

ASM:      /* SPDX-License-Identifier:  */

scripts:  # SPDX-License-Identifier: 

.rst:     .. SPDX-License-Identifier: 

.dts{i}:  // SPDX-License-Identifier: 

```

## Usage

Provide a dictionary, with file types as the keys and a list of accepted licenses as the values.

### Example

```python

      {

        "sol": ["MIT", "BSD-3"],

        "py": ["ISC"]

      }

```

### License Header Examples

#### MDX/JSX

```

/_SPDX-License-Identifier: Apache-2.0

SPDXVersion: SPDX-2.2

SPDX-FileCopyrightText: Copyright 2020 _/

```

#### REGULAR

```

// SPDX-License-Identifier: Apache-2.0

// SPDXVersion: SPDX-2.2

// SPDX-FileCopyrightText: Copyright 2020 

```

#### BASH/YAML/ENV

```

# SPDX-License-Identifier: Apache-2.0

# SPDXVersion: SPDX-2.2

# SPDX-FileCopyrightText: Copyright 2020 

```

#### MARKUP SYNTAX (HTML/MARKDOWN, ETC)

```html

```

## License

SPDX-License-Identifier: Apache-2.0