boromil / news

Minimalist RSS/Atom aggregator 📰

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

License: Unlicense Go Report Card

📰 News

News is a minimalist RSS/Atom aggregator that saves to HTML files.

📂news
  ├📰 index.html
  ├📰 page2.html
  └📰 page3.html

That's it! No database, no configuration files, no HTTP server, no ads, no tracking and no JavaScript. Everything is stored in the HTML files which look like this:

screenshot

Usage

Running news creates 📂news directory containing a sample 📰index.html file which you should edit with your own RSS/Atom feed sources.

Every 10 minutes it fetches news from your feeds and saves what's fresh to 📰index.html.

When 📰index.html grows large (1000 items by default), the oldest 500 items are moved to 📰page2.html.

📂news can reside in Google Drive or Dropbox for easy access everywhere.

This is how I use it:

news -wait 30 -dir "D:/gdrive/news"

Command-line arguments

news -h prints:

  -dir string
        directory to store html files. By default ./news is used and created if necessary
  -items int
        number of items per page.html file. A new page.html file is created whenever index.html contains 2x that number (default 500)
  -noflood duration
        minium seconds between calls to same domain to avoid flooding (default 30s)
  -opml string
        path to OPML file containing feed URLS to be imported. Existing feed URLs are overwritten, not duplicated
  -template news/feed/template.go
        custom Go html/template file to use when generating .html files. See news/feed/template.go
  -timeout duration
        timeout in seconds when fetching feeds (default 10s)
  -verbose
        verbose mode outputs extra info when enabled
  -wait duration
        minutes to wait between updates (default 10m0s)

Running from code

go get -uv github.com/ww9/news

cd $GOROOT/src/github.com/ww9/news

go get ./... to fetch dependencies

go run main.go

Installing from code

go install -i github.com/ww9/news

If you have Go's /bin directory in $PATH env variable, you should be able to run news from anywhere.

Downloading binaries

Windows, Linux and OSX binaries are available in Releases.

Todo

  • More tests
  • Go modules
  • Vendor
  • Dockerfile

License

The Unlicense, Public Domain. As free as it gets.

About

Minimalist RSS/Atom aggregator 📰

License:The Unlicense


Languages

Language:Go 99.1%Language:HTML 0.9%