Skip to content

Latest commit

 

History

History
155 lines (102 loc) · 4.57 KB

README.rst

File metadata and controls

155 lines (102 loc) · 4.57 KB
Raw

django-feedparser

A Django app using feedparser to fetch and parse a feed to render it from a template.

It is not a Feed agregator since it manage feeds one by one.

  • requests is used to fetch feeds;
  • feedparser is used to parse feeds;
  • Django cache is used to avoid fetching again the feed each time;
  • Basic feed renderers just parse the feed without modifying anything but you can extend it to implement your post-process formatting;
  • Once the feed has been fetched, it can be displayed through a template. Default template is really basic and you should eventually override it or create another one to fit to your feed structure/format;
  • A DjangoCMS plugin is available on cmsplugin_feedparser;

Links

Requires

Install

First install the package:

pip install django-feedparser

Add it to your installed Django apps in settings:

INSTALLED_APPS = (
    ...
    'django_feedparser',
    ...
)

Then import its settings:

from django_feedparser.settings import *

And finally see about Available settings you can override.

Usage

Renderers

There is actually two basic renderer available:

basic-xml

Just the basic renderer, parsing an XML feed and return result given by feedparser.

Don't do any special formatting.

basic-json
Like basic-xml but for a JSON feed, obviously don't use feedparser but the json builtin from Python and return the loaded object.

Finally, remember than your renderer have to be compatible with the used template and vice-versa.

Views

There is a mixin django_feedparser.views.FeedFetchMixin you can inherit from your views to exploit a feed.

And there is a basic view django_feedparser.views.FeedView that inherits from mixin FeedFetchMixin to demonstrate its usage. However the basic view is usable as it if it meets your needing, if so you just have to use it directly in your urls like django.views.generic.base.TemplateView:

from django.conf.urls import *

from .views import FeedView

urlpatterns = patterns('',
    ...
    url(r'^myfeed/$', FeedView.as_view(feed_url="http://localhost/myfeed.xml"), name="myfeed"),
    ...
)

Note

Although the app contains an 'urls.py', it's mainly intended for debugging purpose, you should not mount it in your project urls.

Template tags

More common way is to use the template tag to include rendered feed in your templates.

Basic sample:

{% load feedparser_tags %}
{% feedparser_render 'http://localhost/sample.xml' %}

Or with all accepted arguments:

{% feedparser_render 'http://localhost/sample.xml' renderer='CustomRenderer' template='foo/custom.html' expiration=3600 %}

Available settings

FEED_RENDERER_DEFAULT_TEMPLATE

Path to the default renderer template.

Default value: 'django_feedparser/basic_feed_renderer.html'

FEED_CACHE_KEY

Feed cache key template string.

Default value: 'feedparser_feed_{id}_{expire}'

FEED_TIMEOUT

Timeout until feed response, in seconds.

Default value: 5

FEED_BOZO_ACCEPT

Wether we accept (True) badly formatted xml feed or not (False).

Default value: True

FEED_SAFE_FETCHING

Wether fetching a feed throw an exception (False) or not (True).

Bad http status, request errors and timeout error are silently catched when safe fetching is enabled.

Default value: False

FEED_RENDER_ENGINES

A Python dictionnary for available renderer engines, where the key is the shortcut engine name and the value is a valid Python path to the renderer class.

Default value:

{
    'basic-xml': 'django_feedparser.renderer.FeedBasicRenderer',
    'basic-json': 'django_feedparser.renderer.FeedBasicRenderer',
}
DEFAULT_FEED_RENDER_ENGINE

The default renderer engine name to use when no one is given.

Default value: basic-xml