SmeeFeds.Export (SmeeFeds v0.1.0) View Source

Converts lists of federations into other formats suitable for export and use in other applications.

Some exports are focused on presenting the data (such as markdown/1, others are lossy summaries (csv/1) and some are contain all data (json/1).

Link to this section Summary

Functions

Creates a CSV export of the provided federations as a single string.

Produces a string containing all passed federations (or default set) in JSON format.

Produces a simple Markdown-formatted table summarising the provided list of federations.

Link to this section Functions

Link to this function

csv(federations \\ SmeeFeds.federations())

View Source

Specs

csv(federations :: [SmeeFeds.Federation.t()]) :: binary()

Creates a CSV export of the provided federations as a single string.

Not all information is included - the CSV only contains ID, name, URL, countries, policy url and metadata URLs for the main aggregate and MDQ service. Other information is not included.

Link to this function

json(federations \\ SmeeFeds.federations())

View Source

Specs

json(federations :: [SmeeFeds.Federation.t()]) :: binary()

Produces a string containing all passed federations (or default set) in JSON format.

The JSON should contain all federation information and can be used by SmeeFeds as a replacement for the default source of federation information.

Link to this function

markdown(federations \\ SmeeFeds.federations())

View Source

Specs

markdown(federations :: [SmeeFeds.Federation.t()]) :: binary()

Produces a simple Markdown-formatted table summarising the provided list of federations.

Not all information is included - the CSV only contains ID, name, URL, countries, policy url and metadata URLs for the main aggregate and MDQ service. Other information is not included.

The Markdown output can be used with most modern markdown parsers, including Github comments.