Third-party license crawler

crawling thirdparty licenses from package manager files (packages.json, pom.xml, ...)

Quick Start

Install

1$ npm install -g thirdparty-license-crawler

Run cli command on your project directory

1$ crawl-3rd-party-licenses

LICENSE_THIRDPARTY.txt file is created where you running on the script.

Configuration

You can run with your config files

$ crawl-3rd-party-licenses --input <your-config-file>

A example of config file

• pattern_files represented collecting file pattern.
• pattern_excludes are excluding file pattern. These are normally start with ! for ignore.
• module excludes are excluding module pattern witch represented by RegEx format.

1{
2    "pattern_files" : [
3        "**/package.json",
4        "**/pom.xml",
5        "**/requirements.txt",
6    ],
7    "pattern_excludes" : [
8        "!**/node_modules/**"
9    ],
10    "module_excludes" : {
11        "npm" : [
12          "^\\@mymodule"
13        ],
14        "maven" : [
15          "^sample"
16        ],
17        "pypi" : [
18            "^py.*"
19        ]
20    }
21}

Dependencies

This tool is tested on MacOS. Dependelcies are below.

• node.js, npm
• pip3
• grep

Restrictions

• Maven dependelcies are only collect artifact name and version. You have to update license information namually from maven central.
• PiPy packages refer installed pip packages infoemation. Installed PyPi packages only can detect license info.

License

MIT