Skip to main content
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.

Release files for django-wagtail-feeds 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-wagtail-feeds 0.1.0
File Size Uploaded
django-wagtail-feeds-0.1.0.macosx-10.12-x86_64.tar.gz 14.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-wagtail-feeds 0.1.0
File Interpreter ABI Platform
django_wagtail_feeds-0.1.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 28.6 kB

Release files / django-wagtail-feeds-0.1.0.macosx-10.12-x86_64.tar.gz

Download URL django-wagtail-feeds-0.1.0.macosx-10.12-x86_64.tar.gz
Size 14.2 kB
Tags Source
SHA-256 checksum
How to use checksums
3b379cfc29b7ecf73518d878d4fb5680b3319b9056b450a418e58a6daf091f40
BLAKE2b-256 checksum
How to use checksums
4358b31435675f8f6792edd9fcf2191183144020501740edb7e8db3280f96dd3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / django_wagtail_feeds-0.1.0-py2.py3-none-any.whl

Download URL django_wagtail_feeds-0.1.0-py2.py3-none-any.whl
Size 14.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
9c76246cfef49103bbffd7b0cd2d9628fe45b58339f1996e4c388699a80b3618
BLAKE2b-256 checksum
How to use checksums
20952416d1783300a4fb9bdd912f96d89789bf91d9a8307434a93487cafc0937
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page