1
0
mirror of https://github.com/sjlongland/tornado-news.git synced 2025-09-13 18:13:16 +10:00
tornado-news/README.md
tripleee 876cbd1c64 README.md: create PRs in branches
A small note to prospective contributors.
2018-09-01 08:21:35 -05:00

1.2 KiB

TornadoNews: a feed aggregator built on Tornado

TornadoNews is a small feed aggregator much like Planet written to be small and simple.

It uses the Tornado asynchronous framework to fetch RSS and ATOM feeds asynchronously and uses its templating engine to generate the final HTML output. Like Planet, it is intended to be run from a cron job, with the output served up by a conventional HTTP server (e.g. Apache, nginx, lighthttpd, OpenBSD httpd, Microsoft IIS, etc...).

Feeds are parsed using the feedparser module, and a composite RSS feed is generated using feedgenerator.

The code works on both Python 2.7 and 3.4. It has been exclusively developed and tested on Linux. It should work with anything that understands POSIX.

Contributing

Pull requests on GitHub are most welcome. Please always create them on a separate branch so that we can rebase the merge to master; this helps keep the commit history on the master branch clean and noise-free. Thanks in advance!