https://github.com/aurbano/whoss
OSS Attribution Generator [Not ready for use yet]
https://github.com/aurbano/whoss
attribution license open-source oss
Last synced: 11 months ago
JSON representation
OSS Attribution Generator [Not ready for use yet]
- Host: GitHub
- URL: https://github.com/aurbano/whoss
- Owner: aurbano
- License: mit
- Created: 2018-04-03T15:44:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-09T11:09:23.000Z (about 8 years ago)
- Last Synced: 2025-02-18T19:41:40.626Z (over 1 year ago)
- Topics: attribution, license, open-source, oss
- Language: TypeScript
- Homepage: https://aurbano.github.io/whoss
- Size: 949 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# whoss
> Utility to parse npm packages used in a project and generate an attribution file to include in your product.
[](https://travis-ci.org/aurbano/whoss)
[](https://www.npmjs.com/package/whoss)
[](https://coveralls.io/github/aurbano/whoss?branch=master)
[](https://www.npmjs.com/package/whoss)
[](https://www.npmjs.com/package/whoss)
[](https://www.codacy.com/app/aurbano/whoss)
## Installation
Local installation:
```
npm i whoss
```
or
```
yarn add whoss
```
Global installation:
```
npm i -g whoss
```
or
```
yarn global add whoss
```
## Usage
### For a single Node project
```
cd pathToYourProject
whoss
git add ./oss-attribution
git commit -m 'adding open source attribution output from whoss'
```
### Help
Use the `--help` argument to get further usage details about the various program arguments:
```
whoss --help
```
### Understanding the "overrides"
#### Ignoring a package
Sometimes, you may have an "internal" module which you/your team developed, or a module where you've arranged a special license with the owner. These wouldn't belong in your license attributions, so you can ignore them by creating an `overrides.json` file like so:
```
{
"signaling-agent": {
"ignore": true
}
}
```
#### Changing the properties of package in the attribution file only
Other times, you may need to supply your own text for the purpose of the attribution/credits. You have full control of this in the `overrides.json` file as well:
```
{
"some-package": {
"name": "some-other-package-name",
"version": "1.0.0-someotherversion",
"authors": "some person",
"url": "https://thatwebsite.com/since/their/original/link/was/broken",
"license": "MIT",
"licenseText": "you can even override the license text in case the original contents of the LICENSE file were wrong for some reason"
}
}
```
## Running on CI
For a large project with multiple maintainers you will probably want to run this on your CI build server, so that the attributions are always up to date.
## Prior art
Like most software, this component is built on the shoulders of giants; `whoss` was inspired in part by the following work:
- [oss-attribution-generator](https://github.com/zumwald/oss-attribution-generator)
- [license-checker](https://github.com/davglass/license-checker)
- [tldrlegal](https://github.com/eladnava/tldrlegal)