Metadata-Version: 1.1
Name: django-wagtail-feeds
Version: 0.0.8
Summary: Support RSS Feeds, Facebook Instant Articles and Apple News
Home-page: https://github.com/chrisdev/django-wagtail-feeds
Author: Christopher Clarke
Author-email: cclarke@chrisdev.com
License: MIT license
Description: Django Wagtail Feeds
        ====================
        .. image:: https://travis-ci.org/chrisdev/django-wagtail-feeds.svg?branch=master
            :target: https://travis-ci.org/chrisdev/django-wagtail-feeds
        
        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.
        
        .. _`RSS V 2.0.1` : http://cyber.law.harvard.edu/rss/rss.html
        
        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.
        
        .. _`JSON feed` : https://jsonfeed.org/version/1
        
        
        Getting Started
        ---------------
        
        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
        
        .. figure:: http://i.imgur.com/aNp1VBg.png
           :alt: Wagtail admin
        
        .. figure:: http://i.imgur.com/oRZRici.png
           :alt: 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.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.  
        
        .. _`JSON Feed` : https://jsonfeed.org/version/1
        
        
        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.
        
Keywords: wagtail_feeds
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
