# Smee v0.6.0 - Table of Contents

## Pages

- [Smee](readme.md)
- [LICENSE](license.md)

## Modules

- [Smee](Smee.md): `Smee` is a pragmatic library for handling SAML metadata with Elixir, Erlang or any other BEAM language.
- [Smee.Entity](Smee.Entity.md): `Smee` wraps up metadata for individual entities in %Entity{} structs, and the `Smee.Entity` module contains
  functions that may be useful when working with them.
- [Smee.Extract](Smee.Extract.md): Processes `%Metadata{}` structs to extract various information, usually using XSLT.
- [Smee.Fetch](Smee.Fetch.md): Downloads or loads the metadata specified in a `%Smee.Source{}` struct and returns a `%Smee.Metadata{}` struct.
- [Smee.Filter](Smee.Filter.md): Process a stream of entities to include or exclude entity structs matching the specified criteria.
- [Smee.Lint](Smee.Lint.md): Lint runs basic XML quality checks against XML strings

- [Smee.MDQ](Smee.MDQ.md): `Smee.MDQ` provides a client API to MDQ services, and also attempts to emulate MDQ-style behaviour with old-fashioned
  metadata aggregates. MDQ allows individual entities to be looked up when needed without downloading and processing
  an increasingly enormous metadata aggregate file.
- [Smee.Metadata](Smee.Metadata.md): The Metadata module wraps up Metadata XML into a struct and contains functions that may be helpful when working with
  them. The metadata is either an aggregate (as used by federations to contain many entity records) or a single entity.
- [Smee.Publish](Smee.Publish.md): Publishes/exports streams, lists or text files of entity structs in various formats.
- [Smee.Security](Smee.Security.md): `Smee.Security` uses XML signatures to provide anti-tampering and origin authentication features.
- [Smee.Sigils](Smee.Sigils.md): `Smee.Sigils` provides a version of SweetXml's `~x` sigil for creating XPaths, optimised for working with SAML
  metadata. All of Smee's known XML namespaces will be automatically loaded for you.
- [Smee.Source](Smee.Source.md): Defines sources for metadata, which can then be `Fetch`ed and prodoce Metadata structs. Source structs are the
  usual starting-place for Smee tasks.
- [Smee.Stats](Smee.Stats.md): A collection of simple statistics tools that use streams of entity structs (and maybe lists)

- [Smee.Sys](Smee.Sys.md): Contains utility functions for integrating Smee with larger applications, managing caches and working files, and so on.

- [Smee.Transform](Smee.Transform.md): Tools for manipulating metadata XML.

## Mix Tasks

- [mix deps.smee](Mix.Tasks.Deps.Smee.md): Install backend CLI commands required by Smee