Metadata-Version: 2.1
Name: elm-license-finder
Version: 1.0.1
Summary: Collects license information for Elm project dependencies.
Home-page: https://github.com/wolfadex/elm-license-finder
Author: Wolfgang Schuster
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# Elm License Finder
**Python Edition**

## Using Python CLI Script

**Requires Python 3**

Run `python3 -m pip install colorclass terminaltables semver`

If you are running the python script from inside your `elm.json` directory:
`python3 find_licenses.py`

If you are running the python script from a different directory:
`python3 find_licenses.py relative/path/to/elm/project`

## Using Python Package

**Requires Python 3**

Install the package with `python3 -m pip install elm_license_finder`

Import the two needed functions and use them:

```
import os
from elm_license_finder import get_project_dependencies, output_tables

dir = os.path.join("path", "to", "elm", "project")

# Parses elm.json and builds dependency and license data
deps = get_project_dependencies(dir)
# Outputs pretty tables with the information
output_tables(deps)
```


