1
0
mirror of https://github.com/sjlongland/tornado-news.git synced 2025-09-13 10:03:14 +10:00

Add .gitignore and README.md

This commit is contained in:
Stuart Longland 2017-10-15 08:45:46 +10:00
parent 495c14ccd0
commit a622f05ab9
Signed by: stuartl
GPG Key ID: F954BBBB7948D546
2 changed files with 23 additions and 0 deletions

5
.gitignore vendored Normal file
View File

@ -0,0 +1,5 @@
.*.sw?
*.sw?
*.py[co]
build
dist

18
README.md Normal file
View File

@ -0,0 +1,18 @@
TornadoNews: a feed aggregator built on Tornado
===============================================
TornadoNews is a small feed aggregator much like
[Planet](http://www.planetplanet.org/) written to be small and simple.
It uses the [Tornado](http://tornadoweb.org/) 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](https://pypi.python.org/pypi/feedparser/)
module, and a composite RSS feed is generated using
[feedgenerator](https://pypi.python.org/pypi/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.