Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kopoli/licrep
License reporting and embedding tool for Go (golang)
https://github.com/kopoli/licrep
embedding golang licenses
Last synced: about 2 months ago
JSON representation
License reporting and embedding tool for Go (golang)
- Host: GitHub
- URL: https://github.com/kopoli/licrep
- Owner: kopoli
- License: mit
- Created: 2018-01-09T20:50:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-17T16:54:37.000Z (over 3 years ago)
- Last Synced: 2024-06-20T05:21:12.386Z (7 months ago)
- Topics: embedding, golang, licenses
- Language: Go
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# licrep
[](https://godoc.org/github.com/kopoli/licrep)
Report and embed the licenses of your go dependencies.
## The problem
The common Open Source licenses have language which requires the license and
copyright notice be included in all copies of the software.
In MIT license
```
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
```
In BSD license
```
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
```
Go software can be distributed as a single binary and this tool is for
embedding the licenses to that binary.
## Installation
```
$ go get github.com/kopoli/licrep
```
## Usage
Display the summary of the dependencies of your go package by running:
```
$ licrep -s
```
Embed the licenses as a data structure to your program by adding the following
comment:
```
//go:generate licrep -o licenses.go
```
This will create a type called `License` and a function `GetLicenses`, which
returns `[]License, error`.
See all options by running:
```
$ licrep --help
```
For a complete example see `_example/example.go`.
## License
MIT license