{"id":20815841,"url":"https://github.com/aurbano/whoss","last_synced_at":"2025-07-09T10:40:17.399Z","repository":{"id":143929001,"uuid":"127931375","full_name":"aurbano/whoss","owner":"aurbano","description":"OSS Attribution Generator [Not ready for use yet]","archived":false,"fork":false,"pushed_at":"2018-04-09T11:09:23.000Z","size":972,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-18T19:41:40.626Z","etag":null,"topics":["attribution","license","open-source","oss"],"latest_commit_sha":null,"homepage":"https://aurbano.github.io/whoss","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aurbano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-03T15:44:34.000Z","updated_at":"2019-12-18T20:55:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"c6f163b4-fca8-4661-9a5f-88569326d96a","html_url":"https://github.com/aurbano/whoss","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aurbano%2Fwhoss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aurbano%2Fwhoss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aurbano%2Fwhoss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aurbano%2Fwhoss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aurbano","download_url":"https://codeload.github.com/aurbano/whoss/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243163305,"owners_count":20246492,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["attribution","license","open-source","oss"],"created_at":"2024-11-17T21:26:22.815Z","updated_at":"2025-03-12T05:27:01.205Z","avatar_url":"https://github.com/aurbano.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# whoss\n\u003e Utility to parse npm packages used in a project and generate an attribution file to include in your product.\n\n[![Travis](https://img.shields.io/travis/aurbano/whoss.svg)](https://travis-ci.org/aurbano/whoss)\n[![npm](https://img.shields.io/npm/v/whoss.svg)](https://www.npmjs.com/package/whoss)\n[![Coverage Status](https://coveralls.io/repos/github/aurbano/whoss/badge.svg?branch=master)](https://coveralls.io/github/aurbano/whoss?branch=master)\n[![npm](https://img.shields.io/npm/dm/whoss.svg)](https://www.npmjs.com/package/whoss)\n[![npm](https://img.shields.io/npm/l/whoss.svg)](https://www.npmjs.com/package/whoss)\n[![Codacy grade](https://img.shields.io/codacy/grade/e2589a609bdc4c56bd49c232a65dab4e.svg)](https://www.codacy.com/app/aurbano/whoss)\n\n## Installation\n\nLocal installation:\n\n```\nnpm i whoss\n```\nor\n```\nyarn add whoss\n```\n\n\nGlobal installation:\n\n```\nnpm i -g whoss\n```\nor\n```\nyarn global add whoss\n```\n\n## Usage\n\n### For a single Node project\n```\ncd pathToYourProject\nwhoss\ngit add ./oss-attribution\ngit commit -m 'adding open source attribution output from whoss'\n```\n\n### Help\n\nUse the `--help` argument to get further usage details about the various program arguments:\n\n```\nwhoss --help\n```\n\n### Understanding the \"overrides\"\n\n#### Ignoring a package\nSometimes, 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:\n```\n{\n  \"signaling-agent\": {\n      \"ignore\": true \n  }\n}\n```\n\n#### Changing the properties of package in the attribution file only\nOther 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:\n```\n{\n  \"some-package\": {\n    \"name\": \"some-other-package-name\",\n    \"version\": \"1.0.0-someotherversion\",\n    \"authors\": \"some person\",\n    \"url\": \"https://thatwebsite.com/since/their/original/link/was/broken\",\n    \"license\": \"MIT\",\n    \"licenseText\": \"you can even override the license text in case the original contents of the LICENSE file were wrong for some reason\"\n  }\n}\n```\n\n## Running on CI\nFor 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.\n\n## Prior art\nLike most software, this component is built on the shoulders of giants; `whoss` was inspired in part by the following work:\n\n  - [oss-attribution-generator](https://github.com/zumwald/oss-attribution-generator)\n  - [license-checker](https://github.com/davglass/license-checker)\n  - [tldrlegal](https://github.com/eladnava/tldrlegal)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faurbano%2Fwhoss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faurbano%2Fwhoss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faurbano%2Fwhoss/lists"}