shout

README

===== shout ====================================================================

shout is an aggregation library for syndicated data.

===== profiles =================================================================

shout takes a "Profile" as an input, containing A. feed metadata from the Atom
format, B. an SDL collection (see /sdl) containing feeds to aggregate, and C.
optionally an algorithm to describe how data is sorted.

Documentation

Index

• func Aggregate(fs []feeds.Feed, p *Profile) (out feeds.Feed, err error)
• func Exec(p *Profile, o Opts) (feed feeds.Feed, err error)
• func FetchCollection(c *sdl.Collection) (fs []feeds.Feed, err error)
• func FetchFeed(f *sdl.Feed) (feed feeds.Feed, err error)
• func ParamForId[T any](aps AlgParams[T], id string) T
• type AlgParam
• type AlgParams
• type Algorithm
• type Opts
• type Profile
  • func ReadProfile(href string) (p *Profile, err error)
  • func (p *Profile) Hash() (hash string)
• type Weights

Functions

func Aggregate

func Aggregate(fs []feeds.Feed, p *Profile) (out feeds.Feed, err error)

Aggregate combines feeds into one megafeed based on a profile.

func Exec

func Exec(p *Profile, o Opts) (feed feeds.Feed, err error)

func FetchCollection

func FetchCollection(c *sdl.Collection) (fs []feeds.Feed, err error)

func FetchFeed

func FetchFeed(f *sdl.Feed) (feed feeds.Feed, err error)

func ParamForId

func ParamForId[T any](aps AlgParams[T], id string) T

Types

type AlgParam

type AlgParam[T any] struct {
	ForId string `xml:"if_id,attr,omitempty"`
	Value T      `xml:",chardata"`
}

type AlgParams

type AlgParams[T any] []AlgParam[T]

type Algorithm

type Algorithm struct {
	XMLName         xml.Name          `xml:"shout algorithm"`
	GlobalNamespace string            `xml:"xmlns,attr,omitempty"`
	Pins            AlgParams[string] `xml:"shout pin"`
	AgeMax          AlgParams[string] `xml:"shout age_max"`
	Limit           AlgParams[int64]  `xml:"shout limit"`
	Weights         *Weights          `xml:"shout weights,omitempty"`
}

type Opts

type Opts struct {
	PageNum, PageCt int
}

type Profile

type Profile struct {
	XMLName xml.Name `xml:"shout profile"`
	atom.FeedMeta
	GlobalNamespace string          `xml:"xmlns,attr,omitempty"`
	Collection      *sdl.Collection `xml:"sdl collection,omitempty"`
	Algorithm       *Algorithm      `xml:"shout algorithm"`
}

func ReadProfile

func ReadProfile(href string) (p *Profile, err error)

func (*Profile) Hash

func (p *Profile) Hash() (hash string)

type Weights

type Weights struct {
	Age int `xml:"shout age,omitempty"`
}