https://github.com/myles/django-jsonfeed

This library intends to support JSON Feed in Django and feedgenerator.
https://github.com/myles/django-jsonfeed

django jsonfeed python

Last synced: about 1 month ago
JSON representation

This library intends to support JSON Feed in Django and feedgenerator.

• Host: GitHub
• URL: https://github.com/myles/django-jsonfeed
• Owner: myles
• License: mit
• Created: 2018-02-16T23:16:55.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-08-02T01:29:22.000Z (over 1 year ago)
• Last Synced: 2024-10-01T18:07:08.147Z (about 2 months ago)
• Topics: django, jsonfeed, python
• Language: Python
• Homepage:
• Size: 264 KB
• Stars: 11
• Watchers: 3
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.rst

Awesome Lists containing this project

README

        
===============

Django-JSONFeed

===============

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

.. image:: design/repository-open-graph-template.png

    :target: https://django-jsonfeed.mylesbraithwaite.org/

    :alt: Django JSONFeed

Usage

-----

If you are using Django:

.. code-block:: python

    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:

.. code-block:: python

    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/