# LowEndInsight v0.9.0 - Table of Contents

LowEndInsight is a simple 'bus-factor' risk analysis library for Open Source Software which is managed within a Git repository. Provide the git URL and the library will respond with a basic Elixir Map structure report.

## Pages

- [LowEndInsight](readme.md)

## Modules

- [AnalyzerModule](AnalyzerModule.md): Analyzer takes in a valid repo URL and coordinates the analysis,
returning a simple JSON report.  The URL can be one of "https", "http",
or "file".  Note, that the latter scheme will only work an existing clone
and won't remove the directory structure upon completion of analysis.

- [Contributor](Contributor.md)
- [CounterAgent](CounterAgent.md)
- [Data](Data.md)
- [GitHelper](GitHelper.md): Collection of lower-level functions for analyzing outputs from git command.

- [GitModule](GitModule.md): Collections of functions for interacting with the `git` command to perform queries.

- [GitModule.Behaviour](GitModule.Behaviour.md): Behaviour definition for GitModule operations.
- [Helpers](Helpers.md): Collection of generic helper functions.

- [Hex.Encoder](Hex.Encoder.md):   Provides map to json encoder

- [Hex.Library](Hex.Library.md)
- [Hex.Lockfile](Hex.Lockfile.md):   Provides mix.lock dependency parser
  From: https://github.com/librariesio/mix-deps-json/blob/master/lib/lockfile.ex

- [Hex.Mixfile](Hex.Mixfile.md):   Provides mix.exs dependency parser
  From: https://github.com/librariesio/mix-deps-json/blob/master/lib/mixfile.ex

- [Hex.Scanner](Hex.Scanner.md): Scanner scans for mix dependencies to run analysis on.

- [Lowendinsight.Files](Lowendinsight.Files.md)
- [Npm.Packagefile](Npm.Packagefile.md):   Provides package.json and package-lock.json dependency parser

- [Npm.Scanner](Npm.Scanner.md): Scanner scans for node dependencies to run analysis on.

- [Npm.Yarnlockfile](Npm.Yarnlockfile.md):   Provides yarn.lock dependency parser

- [Parser](Parser.md)
- [ProjectIdent](ProjectIdent.md):   ProjectIdent module

- [ProjectType](ProjectType.md)
- [Pypi.Requirements](Pypi.Requirements.md):   Provides a requirements.txt dependency parser		

- [Pypi.Scanner](Pypi.Scanner.md): Scanner scans for python dependencies to run analysis on.

- [RepoReport](RepoReport.md)
- [Results](Results.md)
- [RiskLogic](RiskLogic.md): RiskLogic contains the functionality for determining risk based on
numeric input values

- [SbomModule](SbomModule.md): Scan for a SBOM and validate.

- [ScannerModule](ScannerModule.md): Scanner scans.

- [TimeHelper](TimeHelper.md): Collection of functions for handling time-based conversions.

## Mix Tasks

- [mix echo](Mix.Tasks.Echo.md): Printed when the user requests `mix help echo`
- [mix lei.analyze](Mix.Tasks.Lei.Analyze.md): This is used to run a LowEndInsight scan against a repository, by cloning it locally, then looking
into it.  Pass in the repo URL as a parameter to the task.
- [mix lei.batch_bulk_analyze](Mix.Tasks.Lei.BatchBulkAnalyze.md)
- [mix lei.bulk_analyze](Mix.Tasks.Lei.BulkAnalyze.md): This is used to run a LowEndInsight scan against a repository, by cloning it locally, then looking
into it.  Pass in the repo URL as a parameter to the task.
- [mix lei.dependencies](Mix.Tasks.Lei.Dependencies.md): This is used to run LowEndInsight to generate a transitive-dependency
list, as JSON, for a given repository.
- [mix lei.scan](Mix.Tasks.Lei.Scan.md): This is used to run a LowEndInsight scanner against a project.