https://github.com/mdbecker/feedloggr

Collect news from your favorite RSS/Atom feeds and show them in your flask application.
https://github.com/mdbecker/feedloggr

Last synced: about 2 months ago
JSON representation

Collect news from your favorite RSS/Atom feeds and show them in your flask application.

• Host: GitHub
• URL: https://github.com/mdbecker/feedloggr
• Owner: mdbecker
• License: mit
• Created: 2014-08-17T18:13:37.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-02-24T16:07:23.000Z (almost 11 years ago)
• Last Synced: 2023-03-12T08:28:49.153Z (almost 2 years ago)
• Homepage:
• Size: 434 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
feedloggr

=========

Collect news from your favorite RSS/Atom feeds and show them in your flask application.

This is the bigger brother of [simple_feedlog](https://github.com/lmas/simple_feedlog).

Installation

------------

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!

Management

----------

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='[email protected]',

        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](http://flask.pocoo.org/docs/appcontext/).

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.

Configuration

-------------

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).

Templates

---------

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:

    

    

    Your title here!

    


        {% block content %}{% endblock %}

    


Example

-------

Inside of `example/` is a fully working example app.

Contribution

------------

Any and all contributions are welcome! Only requirement is that you make sure to

(at least loosely) follow [PEP8](http://www.python.org/dev/peps/pep-0008/) 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.

Credits

-------

See AUTHORS for a complete list.

License

-------

MIT License, see LICENSE.