analice

command
v1.4.23 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 11, 2018 License: MIT Imports: 13 Imported by: 0

README

analice

About

Get an overview of OSS licenses used in your go project.

Build

go build

Usage

Generate NOTICE file
analice generate notice /path/to/github.com/user/project
analice generate copyright /path/to/github.com/user/project

Assumptions

  • Root project uses dep as dependency management, Gopkg.lock need to be present in root directory.
  • Every dependency is licensed under one license known to this tool.
  • All dependencies need to be in the vendor folder including their LICENSE files.

Known limitations

  • Skips dependencies without license, either because they don't have one or it is absent in vendor folder.
  • Skips dependencies which bury the license file in a non-standard location, e.g. by embedding it in README.
  • Sometimes does not work for dependencies with heavy re-formatting of the LICENSE file, e.g. by using markdown, prefixing every line wth "> ", etc. Line breaks and spaces are OK though.
  • A quick test showed this tool to work on ~50% of the projects in my GOPATH.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL