Skip to main content

Support RSS Feeds, Facebook Instant Articles and Apple News

Project description

https://travis-ci.org/chrisdev/django-wagtail-feeds.svg?branch=master

Support RSS Feeds, JSON Feed, Facebook Instant Articles and Apple News. Syndication feeds come in two flavors:

  • BasicFeed - A standard RSS V 2.0.1 feed designed to be used without item enclosures.
  • ExtendedFeed - An RSS V2/Atom Feed with support for item enclosures such as images or video. Use this if when want to integrate your feed with services like MailChimp or Flipboard.

JSON feed come in two flavors:

  • BasicJsonFeed - A standard JSON feed designed to be used without content html.
  • ExtendedJsonFeed - A JSON feed with support for content html in items.

Getting Started

The latest release (0.1.0) breaks backward compatibility with previous versions of Wagtail which were baseed Django 1.x. Use 0.0.8 for projects based on older versions of Wagtail

To use Django Wagtail Feeds in a project:

pip install django-wagtail-feeds

Remember to add wagtail_feeds to installed apps in settings file.

django-wagtail-feeds has a dependency on wagtail settings app. You must add wagtail.contrib.settings to your INSTALLED_APPS:

INSTALLED_APPS += [
    'wagtail.contrib.settings',
    'wagtail_feeds',
]

Run migrations for Wagtail feeds:

./manage.py migrate wagtail_feeds

Add Feed settings in the Wagtail admin

Wagtail admin
Feed Settings

Finally reference it in the url.py

from wagtail_feeds.feeds import BasicFeed, BasicJsonFeed, ExtendedFeed, ExtendedJsonFeed

url(r'^blog/feed/basic$', BasicFeed(), name='basic_feed'),
url(r'^blog/feed/extended$', ExtendedFeed(), name='extended_feed'),

# JSON feed
url(r'^blog/feed/basic.json$', BasicJsonFeed(), name='basic_json_feed'),
url(r'^blog/feed/extended.json$', ExtendedJsonFeed(), name='extended_json_feed'),

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

History

0.1.0 (2018-05-8)

  • Adds support for Django 2+ and Wagtail 2+. This release breaks backward compatibility with versions of Wagtail which are based on Wagtail/Django 1.x. Use 0.0.8 for projects based on older versions of Wagtail

0.0.8 (2017-06-26)

  • Provide initial support for JSON Feed_.

    The JSON Feed format is a pragmatic syndication format, like RSS and Atom, but with one big difference: it’s JSON instead of XML.

0.0.7 (2017-05-22)

  • Support for Django 1.11 and Wagtail 1.10.1
  • Temporarily reduce test coverage

0.0.6 (2016-10-06)

  • More comprehensive test coverage

0.0.5 (2016-10-05)

  • Added tests for StreamFields

0.0.4 (2016-09-29)

  • The ExtendedFeed now supports content fields based on StreamFields
  • Previous versions automatically added the post/article’s feed image to the content enclosure. In this version, this can be toggled on or off with a checkbox option in the Feed App Settings
  • Several bug fixes related to issues such the rendering of embedded objects in posts and improperly formatted images

0.0.3 (2016-07-18)

  • Needed to pin html5lib version due to problems with BS4

0.0.2 (2016-07-13)

  • First release on PyPI.

Project details


Release history Release notifications

This version
History Node

0.1.0

History Node

0.0.8

History Node

0.0.7

History Node

0.0.6

History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-wagtail-feeds-0.1.0.macosx-10.12-x86_64.tar.gz (14.2 kB) Copy SHA256 hash SHA256 Source None May 8, 2018
django_wagtail_feeds-0.1.0-py2.py3-none-any.whl (14.4 kB) Copy SHA256 hash SHA256 Wheel py2.py3 May 8, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page