The highest tagged major version is
README
¶
OpenMensaRSS
OpenMensa RSS library and feed generation in Go.
Libary Usage
This library offers two simple functions to query OpenMensa using go-openmensa for a canteen, which return a gorilla/feeds Feed.
The returned feed structs can subsequently be modified and exported as RSS or Atom.
How does this work?
Furthermore, this repository also implements automatic RSS feed generation. The daily generated feeds are then published on GitHub pages. The RSS feed can then be used, embedded or read on any website or reader. For instance, you can add a RSS feed to your Tuwel frontpage.
The published RSS feeds use the same IDs as OpenMensa, e.g. the TU Wien canteen is served at https://schicho.github.io/openmensarss/1098.xml.
A GitHub Actions runner queries the OpenMensa API every day for selected canteens. Using this glue code library the runner creates a RSS feed for each canteen. Subsequently, the generated RSS feeds are deployed on GitHub pages.
More feeds can be found at https://schicho.github.io/openmensarss/.
Documentation
¶
Index ¶
Constants ¶
const OpenMensaRSSGenerator string = "OpenMensa RSS Generator"
Variables ¶
var RSSMetadata = struct { Description string Author feeds.Author Link feeds.Link Image feeds.Image }{ Description: "Automated RSS feed using OpenMensa", Author: feeds.Author{Name: OpenMensaRSSGenerator, Email: "johann.schicho@tuwien.ac.at"}, Link: feeds.Link{Href: "https://schicho.github.io/openmensarss/"}, Image: feeds.Image{Url: "https://schicho.github.io/openmensarss/omrss.gif", Title: OpenMensaRSSGenerator, Link: "https://schicho.github.io/openmensarss/"}, }
RSSMetadata allows setting of general metadata for the feeds generated using this library's functions. All fields can be modified here before generation, or of course after generation on a per feed basis.
Functions ¶
func FeedForCanteen ¶
FeedForCanteen creates a feed of the canteen menu on a certain day. The Canteen struct specifies the canteen from OpenMensa. The day is selected by passing a time stamp.
Throws an error if the OpenMensa API does not provide data for the specified input.
func FeedForCanteenID ¶
FeedForCanteenID creates a feed of the canteen menu on a certain day. The id specifies the canteen from OpenMensa. The day is selected by passing a time stamp.
Throws an error if the OpenMensa API does not provide data for the specified input.
Types ¶
This section is empty.
Source Files
Directories