licenses-from-spdx

This package generates a pair of data files listing all SPDX licenses and exceptions found from the SPDX database. Use it as an NPM library or a command line tool.

About The Project

The SPDX syntax for expressing license terms comes from the Software Package Data eXchange (SPDX), a standard from the Linux Foundation for shareable data about software package license terms. SPDX aims to make sharing and auditing license data easy, especially for users of open-source software.

The SPDX also hosts a set of data files describing those licenses in JSON and RDF formats, suitable for programmatic access.

The objective of licenses-from-spdx is to allow easily generating a local copy of the SPDX database.

Getting Started

Installation for command line use

With a global install from the NPM registry:

1. Install the NPM package globally

   $ npm install -g licenses-from-spdx

By cloning the Git repository and installing locally:

1. Clone the repo

   $ git clone https://github.com/lkoskela/licenses-from-spdx.git

2. Install NPM packages

   $ npm install

3. Link the CLI entrypoint to your PATH

   $ npm link

Installation for programmatic use

1. Install the licenses-from-spdx package as a dependency

   $ npm install --save licenses-from-spdx

2. Import the generation function in your code...

   import { generateLicenseData } from 'licenses-from-spdx'

Usage

Command line usage

After installing for command-line use, run the licenses-from-spdx command and tell it where to write your JSON files:

$ licenses-from-spdx -l ~/Downloads/licenses.json -e ~/Downloads/exceptions.json

If the files exist and are recent enough, the tool won't bother regenerating them.

Programmatic usage

Generate the SPDX license and exception files:

import { generateLicenseData } from 'licenses-from-spdx'

const { licenses, exceptions } = generateLicenseData('./licenses.json', './exceptions.json')

Roadmap

None at the moment.

See open issues for a full and up to date list of requested and proposed features (and known issues) and their state.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Once you feel good about the contribution, its tests all pass (npm test) and test coverage looks good, go ahead and open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

The Linux Foundation and its contributors license the SPDX standard under the terms of the Creative Commons Attribution License 3.0 Unported (SPDX: "CC-BY-3.0"). "SPDX" is a United States federally registered trademark of the Linux Foundation. The authors of this package license their work under the terms of the MIT License.

Acknowledgments

• Othneil Drew for the Best-README-Template