Metadata-Version: 2.0
Name: django-jsonfeed
Version: 0.2.0
Summary: JSONFeed syndication in Django.
Home-page: https://github.com/myles/django-jsonfeed
Author: Myles Braithwaite
Author-email: me@mylesbraithwaite.org
License: MIT
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Flask
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy


===============
Django-JSONFeed
===============

.. image:: https://travis-ci.org/myles/django-jsonfeed.svg?branch=master
    :target: https://travis-ci.org/myles/django-jsonfeed
    :alt: CI Status
.. image:: https://readthedocs.org/projects/django-jsonfeed/badge/?version=latest
    :target: http://django-jsonfeed.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

This library intends to support `JSON Feed`_ in Django_ and feedgenerator_.

Usage
-----

If you are using Django::

    from django.contrib.syndication.views import Feed
    from jsonfeed import JSONFeed

    class ExampleFeed(Feed):
        type = JSONFeed

If you are using this library without Django, you will first need to install the feedgenerator_ Python package::

    from jsonfeed import JSONFeed

    feed = JSONFeed(
        title='Hello, World!',
        link='https://example.com/',
        language='en'
    )

    feed.add_item(
        title='One',
        link='https://example.com/1/',
        pubdate=datetime(2018, 2, 28, 15, 16)
    )

    return feed.writeString()

Installation
------------

    $ pip install django-jsonfeed

.. _JSON Feed: https://jsonfeed.org/
.. _feedgenerator: https://pypi.python.org/pypi/feedgenerator
.. _Django: https://djangoproject.com/


