andreasofthings / feeds

Django app to collect aggregate and read news

NOT MAINTAINED ANYMORE.
=====
Feeds

Feeds aims to be a feed aggregator, reader, subscription service, and potentially a replacement for feedburner. It is under heavy development and not in active use. At the time being it serves as a project in code development and maintenance.

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 meta information.

As a side effort, feeds queries social media to evaluate the relevance of individual posts and collects metrics available from the open web, trying to identify most relevant news.

Source for Documentation is in the "docs" directory.

Quick start

1. Add "feeds" to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = (
       ...
       'feeds',
   )

2. URL configuration

   1. Include the feeds URLconf in your project urls.py like this:

      urlpatterns = patterns(
          '',
          ...
          url(r'^feeds/', include( 'feeds.urls', namespace="planet", app_name="planet")),
      )

      Mind the namespace.

   2. For the API, also include the following URLs:

      urlpatterns = patterns(
          '',
          ...
          url(r'^feeds/', include( 'feeds.urls', namespace="planet", app_name="planet")),
          url(r'^feedapi/', include('feeds.api_urls')),
      )

      In this case, mind the absence of an namespace.

3. Django apps

Add the following to INSTALLED_APPS, too...

INSTALLED_APPS = (

... 'crispy_forms', 'category', 'haystack', )

feeds uses crispy_forms, category, haystack in it's default templates.

4. Run python manage.py syncdb to create the feeds models.
5. Other dependencies:

feeds may assume it will find the following:

• /static/bs335 for Bootstrap.
• /static/jquery for jquery.
• /static/d3 for D3.

6. Guidelines

feeds makes an effort to follow best practices and follows PEP8 and PEP263 as a baseline.