thirdparty-license-crawler v0.0.8

Third-party license crawler

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

Quick Start

Install

$ npm install -g thirdparty-license-crawler

Run cli command on your project directory

$ 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.

{
    "pattern_files" : [
        "**/package.json",
        "**/pom.xml",
        "**/requirements.txt",
    ],
    "pattern_excludes" : [
        "!**/node_modules/**"
    ],
    "module_excludes" : {
        "npm" : [
          "^\\@mymodule"
        ],
        "maven" : [
          "^sample"
        ],
        "pypi" : [
            "^py.*"
        ]
    }
}

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