Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unnawut/licensir
An Elixir mix task that lists all the licenses used by your Mix project dependencies.
https://github.com/unnawut/licensir
elixir elixir-lang hacktoberfest legal license license-scan mix mix-tasks
Last synced: 7 days ago
JSON representation
An Elixir mix task that lists all the licenses used by your Mix project dependencies.
- Host: GitHub
- URL: https://github.com/unnawut/licensir
- Owner: unnawut
- License: mit
- Archived: true
- Created: 2017-11-11T10:44:28.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-01T16:10:29.000Z (over 3 years ago)
- Last Synced: 2024-10-02T11:38:51.161Z (about 1 month ago)
- Topics: elixir, elixir-lang, hacktoberfest, legal, license, license-scan, mix, mix-tasks
- Language: Elixir
- Homepage: https://hex.pm/packages/licensir
- Size: 116 KB
- Stars: 74
- Watchers: 3
- Forks: 27
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A mix task that lists the license(s) of all installed packages in your project. (Miscellaneous)
- fucking-awesome-elixir - licensir - A mix task that lists the license(s) of all installed packages in your project. (Miscellaneous)
- awesome-elixir - licensir - A mix task that lists the license(s) of all installed packages in your project. (Miscellaneous)
README
**Notice: This repository is now archived.** Thank you for over 192,000 downloads since December 2017. While I think Elixir is an awesome ecosystem, I no longer have the chance to be developing using Elixir on a regular basis. :'(
-----
# Licensir
[](https://travis-ci.org/unnawut/licensir)
[](https://coveralls.io/github/unnawut/licensir?branch=master)
[](https://hex.pm/packages/licensir)
[](https://hexdocs.pm/licensir/)
[](https://hex.pm/packages/licensir)
[](https://github.com/unnawut/licensir/blob/master/LICENSE.md)
[](https://github.com/unnawut/licensir/commits/master)
An Elixir mix task that list the license(s) of all installed packages in your project.
## Installation
The package can be installed by adding `:licensir` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:licensir, "~> 0.7", only: :dev, runtime: false}
]
end
```
This mix task in most cases only needs to be run on a development machine and independent from the runtime applications, hence the `only: dev, runtime: false` options.
#### Install locally
If you do not wish to include this tool as part of your dependencies, you may also install it locally by running:
```elixir
$ mix archive.install hex licensir 0.7.0
```
Now you can access this tool from any path on your local machine that has access to `mix`.
## Usage
Run `mix licenses` to get the list of packages and their licenses:
```shell
$ mix licenses
+---------------------+---------+--------------------------------------------------------+
| Package | Version | License |
+---------------------+---------+--------------------------------------------------------+
| certifi | | BSD |
| earmark | 1.3.2 | Apache 2.0 |
| ex_doc | 0.20.2 | Apache 2.0 |
| excoveralls | | Unsure (found: MIT, Unrecognized license file content) |
| hackney | | Apache 2.0 |
| idna | | Unsure (found: BSD, MIT) |
| jason | | Apache 2.0 |
| makeup | 0.8.0 | Unsure (found: BSD, Unrecognized license file content) |
| makeup_elixir | 0.13.0 | BSD |
| metrics | | BSD |
| mimerl | | MIT |
| nimble_parsec | 0.5.0 | Apache 2.0 |
| ssl_verify_fun | | MIT |
| table_rex | 2.0.0 | MIT |
| unicode_util_compat | | Unsure (found: Apache 2.0, BSD) |
+---------------------+---------+--------------------------------------------------------+
```
Run `mix licenses --csv` to output in csv format:
```csv
Package,Version,License
certifi,,BSD
earmark,1.3.2,Apache 2.0
ex_doc,0.20.2,Apache 2.0
excoveralls,,"Unsure (found: MIT, Unrecognized license file content)"
hackney,,Apache 2.0
idna,,"Unsure (found: BSD, MIT)"
jason,,Apache 2.0
makeup,0.8.0,"Unsure (found: BSD, Unrecognized license file content)"
makeup_elixir,0.13.0,BSD
metrics,,BSD
mimerl,,MIT
nimble_parsec,0.5.0,Apache 2.0
ssl_verify_fun,,MIT
unicode_util_compat,,"Unsure (found: Apache 2.0, BSD)"
```
### Flags
* `--top-level-only` - Only fetch license information from top level dependencies (e.g. packages that are directly listed in your application's `mix.exs`). Excludes transitive dependencies.
## Usage as a library
You may call the function `Licensir.Scanner.scan()` from your Elixir application to get a list of license data per dependency.
```elixir
iex> Licensir.Scanner.scan([])
[
%Licensir.License{
app: :jason,
dep: %Mix.Dep{
app: :jason,
deps: ...
},
file: "Apache 2",
hex_metadata: ["Apache 2.0"],
license: "Apache 2.0",
mix: nil,
name: "jason",
version: nil
},
%Licensir.License{...},
...
]
```
## Copyright and License
Copyright (c) 2017, Unnawut Leepaisalsuwanna.
This library is released under the MIT License. See the [LICENSE.md](./LICENSE.md) file
for further details.
This project contains 3rd party work as follow:
- ASCII table rendering: a [partial copy](https://github.com/unnawut/licensir/tree/master/lib/table_rex) of [djm/table_rex](https://github.com/djm/table_rex).
- CSV rendering: a [partial copy](https://github.com/unnawut/licensir/tree/master/lib/csv) of [beatrichartz/csv](https://github.com/beatrichartz/csv).