Welcome to feeds documentation!

https://travis-ci.org/aneumeier/feeds.png?branch=master https://coveralls.io/repos/aneumeier/feeds/badge.png

Feeds aims to be a feed aggregator, readed and potentially a replacement for feedburner.

It is realized as a Django app. It takes feeds in any format feedparser can understand and aims to reproduce identical but trackable feeds, augmented with feedbrater information.

Documentation is in the “docs” directory.

Quick start

  1. Add “feeds” to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = (
        ...
        'feeds',
    )
    
  2. Include the feeds URLconf in your project urls.py like this:

        url(r'^feeds/', include( 'feeds.urls', namespace="planet", app_name="planet")),
    
    
    Mind the namespace `planet` that is used throughout the application for
    reversing URLs.
    
  3. Run python manage.py syncdb to create the feeds models.

Todos

Todo

should use ‘slug’ instead of ‘id’

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/models/feed.py:docstring of feeds.models.Feed.get_absolute_url, line 3.)

Todo

implement this depending on :py:feeds.models.rating

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/models/post.py:docstring of feeds.models.Post.score, line 1.)

Todo

should use ‘slug’ instead of ‘id’

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/models/website.py:docstring of feeds.models.WebSite.get_absolute_url, line 3.)

Todo

This is a bit of magic, that should rather not happen. It strips http:// https:// and www, if present.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/models/website.py:docstring of feeds.models.WebSite.save, line 4.)

Todo

The entire options approach should be architected better and have better tests. Contained options are neither complete nor are these consequently used across the codebase.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/views/views.py:docstring of feeds.views.OptionsView, line 10.)

Todo

The OPML Import should work on a per user basis. OPML is plain text format, but since uploaded by individuals, that should reflect in user/ownership.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/views/views.py:docstring of feeds.views.OPMLView, line 3.)

Todo

The view for Feed Details shall include stats for the particular Feed. It is a plain Class Based View right now.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/views/views.py:docstring of feeds.views.FeedDetailView, line 3.)

Todo

Is this redundant?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/views/views.py:docstring of feeds.views.PostListView.get_queryset, line 10.)

Todo

At the time being PostSubscriptionView is a bare stub. It does not yet have the correct queryset, that limits results to posts from actually subscribed feeds, neither does it have a proper tests for the functionality.

Also, this view is not accessiable through an URL for now.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/feeds/checkouts/latest/feeds/views/views.py:docstring of feeds.views.PostSubscriptionView, line 3.)

Indices and tables