rss

package module

v0.1.1 Latest Latest Go to latest Published: Jul 16, 2018 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/crazcalm/go-rss-reader

Links

Open Source Insights

README ¶

go-rss-reader

My attempt at making a terminal rss reader (based off newsbeuter)

Dependencies

Sqlite3

Setup

The application assumes that you have two things:

~/.go-rss-reader directory in your home path
~/.go-rss-reader/urls file that lists a rss feed url (one per line)

Build Instructions

Clone this repo
build _examples/rss-reader.go
(recommendation) add rss-reader to your PATH

Commands

All commands are CTRL + char (with the exception of Enter, which allows you to select a feed of an episode).

b: Back
c: Quit
r: Refresh feed
a: Refresh all feeds

Gotchas

Refreshing all feeds will lock up the screen until the application has finished updating all the feeds. If this lag time bothers you, I would recommend refreshing your feeds individually.

Documentation ¶

Index ¶

Variables
func EpisodeContentInit(g *gocui.Gui) error
func EpisodesInit(g *gocui.Gui) error
func FeedsInit(g *gocui.Gui) error
func QuitEpisodes(g *gocui.Gui, v *gocui.View) error
func QuitPager(g *gocui.Gui, v *gocui.View) error
func SelectEpisode(g *gocui.Gui, v *gocui.View) (err error)
func SelectFeed(g *gocui.Gui, v *gocui.View) (err error)
func UpdateFeed(g *gocui.Gui, v *gocui.View) error
func UpdateFeeds(g *gocui.Gui, v *gocui.View) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	//FeedsData -- Global container for the Feeds
	FeedsData database.Feeds
	//CurrentFeedID -- Global container for the current Feed ID
	CurrentFeedID int64
	//URLFile -- is the path to the url file
	URLFile = filepath.Join(".go-rss-reader", "urls")
)

View Source

var (
	//CurrentEpisodeID -- Global reference to the episode ID of the currently viewed
	//or last viewed episode
	CurrentEpisodeID int64
)

Functions ¶

func EpisodeContentInit ¶

func EpisodeContentInit(g *gocui.Gui) error

EpisodeContentInit -- Initializes the Episode content for the Gui

func EpisodesInit ¶

func EpisodesInit(g *gocui.Gui) error

EpisodesInit -- Episodes Init for the Gui

func FeedsInit ¶

func FeedsInit(g *gocui.Gui) error

FeedsInit -- Feeds Init for the Gui

func QuitEpisodes ¶

func QuitEpisodes(g *gocui.Gui, v *gocui.View) error

QuitEpisodes -- Callback used to quit the Episodes view and return to the feeds view

func QuitPager ¶

func QuitPager(g *gocui.Gui, v *gocui.View) error

QuitPager -- Callback used to quit the pager view and return to the Episodes view

func SelectEpisode ¶

func SelectEpisode(g *gocui.Gui, v *gocui.View) (err error)

SelectEpisode -- Callback used to select a feed

func SelectFeed ¶

func SelectFeed(g *gocui.Gui, v *gocui.View) (err error)

SelectFeed -- Callback used to select an episode

func UpdateFeed ¶

func UpdateFeed(g *gocui.Gui, v *gocui.View) error

UpdateFeed -- Updates a single feed

func UpdateFeeds ¶

func UpdateFeeds(g *gocui.Gui, v *gocui.View) error

UpdateFeeds -- Update all feeds being shown

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
_examples
database
file
interface
_examples command

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL