Collect news from your favorite RSS/Atom feeds and show them in your flask application. This is the bigger brother of simple_feedlog.
First things first! You're going to have to download the feedloggr source to your local box somehow. The easiest thing at the moment is by cloning this git repo:
git clone https://github.com/lmas/feedloggr.git
In order to run feedloggr, it needs some libraries installed:
pip install -r requirements.txt
You can now run feedloggr in your flask app!
You can easily manage feedloggr from the builtin web admin interface, from
flask-peewee, by visiting http://your.domain.com/feedloggr/admin/ and logging
in there.
Before that, you have to setup a admin user with flask_peewee.auth:
# --- Setup a flask app with flask_peewee.auth before this ---
from getpass import getpass
admin_name = raw_input('Username: ')
user = auth.User.create(
username = 'admin',
email='admin@example.com',
password = '',
admin=True,
active=True,
)
user.set_password(getpass())
user.save()
You can then login to the admin interface and add new Rss/Atom feed URLs.
Updating feedloggr with more, up to date news is done by calling
feedloggr.utils.update_feeds() within a flask app context.
Example:
# --- Setup a flask app before this ---
from feedloggr.utils import update_feeds
with flask_app.app_context():
new_items = update_feeds()
print('feedloggr was updated with %i new items.' % new_items)
feedloggr will then run through each one of it's stored feeds' URLs and download any new items and store them in the database.
feedloggr has only a few, simple configuration variables it will try to use:
FEEDLOGGR_MAX_ITEMS = [int]
Tell feedloggr how many items it should try to load from a feed when
updating news.
FEEDLOGGR_URL = [string]
Register feedloggr at this url prefix (example: /feedloggr).
By default, feedloggr tries to load a base template base.html and add it's
content to a content block. You can easily make your own base template in your
app and override feedloggr's. Example:
<!DOCTYPE html>
<meta charset="UTF-8">
<title>Your title here!</title>
<div>
{% block content %}{% endblock %}
</div>
Inside of example/ is a fully working example app.
Any and all contributions are welcome! Only requirement is that you make sure to (at least loosely) follow PEP8 when editing the code. Also make sure your code will pass the tests.
The Makefile has some simple utils for helping with the developement, I recommend you check it out.
See AUTHORS for a complete list.
MIT License, see LICENSE.