Skip to content
This repository has been archived by the owner on Apr 4, 2023. It is now read-only.
/ go-pkg-rss Public archive
forked from mattn/go-pkg-rss

This package reads RSS and Atom feeds and provides a caching mechanism that adheres to the feed specs.

License

Notifications You must be signed in to change notification settings

compose/go-pkg-rss

 
 

Repository files navigation

RSS

NOTICE

This is forked repository that was provided from github.com/jteeuwen/go-pkg-rss.

See https://www.reddit.com/r/golang/comments/7vv9zz/popular_lib_gobindata_removed_from_github_or_why/

This package allows us to fetch Rss and Atom feeds from the internet. They are parsed into an object tree which is a hybrid of both the RSS and Atom standards.

Supported feeds are:

  • Rss v0.91, 0.92 and 2.0
  • Atom 1.0

The package allows us to maintain cache timeout management. This prevents us from querying the servers for feed updates too often and risk ip bans. Apart from setting a cache timeout manually, the package also optionally adheres to the TTL, SkipDays and SkipHours values specified in the feeds themselves.

Note that the TTL, SkipDays and SkipHour fields are only part of the RSS spec. For Atom feeds, we use the CacheTimeout in the Feed struct.

Because the object structure is a hybrid between both RSS and Atom specs, not all fields will be filled when requesting either an RSS or Atom feed. I have tried to create as many shared fields as possible but some of them simply do not occur in either the RSS or Atom spec.

The Feed object supports notifications of new channels and items. This is achieved by passing 2 function handlers to the feeder.New() function. They will be called whenever a feed is updated from the remote source and either a new channel or a new item is found that previously did not exist. This allows you to easily monitor a feed for changes. See feed_test.go for an example of how this works.

DEPENDENCIES

github.com/mattn/go-pkg-xmlx

USAGE

An idiomatic example program can be found in testdata/example.go.

About

This package reads RSS and Atom feeds and provides a caching mechanism that adheres to the feed specs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 100.0%