From 257e451cbdb6277b927f76dcd8254dec685670fd Mon Sep 17 00:00:00 2001 From: Gareth Simpson Date: Thu, 18 Apr 2024 19:15:18 +0100 Subject: [PATCH] Docs and version bump --- docs/modules/overview.rst | 27 +++++++++++++++++---------- readme.rst | 9 --------- setup.py | 2 +- 3 files changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/modules/overview.rst b/docs/modules/overview.rst index 930806c..b0a71e8 100644 --- a/docs/modules/overview.rst +++ b/docs/modules/overview.rst @@ -29,6 +29,23 @@ Installation - Set ``FEEDS_SERVER`` to preferred web address of your service so that feed hosts can locate you if required e.g. ``https://example.com`` - Setup a mechanism to periodically refresh the feeds (see below) +Optional Settings +^^^^^^^^^^^^^^^^^ + +- ``FEEDS_VERIFY_HTTPS`` (Default True) + - Older versions of this library did not verify https connections when fetching feeds. + Set this to ``False`` to revert to the old behaviour. +- ``KEEP_OLD_ENCLOSURES`` (Default False) + - Some feeds (particularly podcasts with Dynamic Ad Insertion) will change their enclosure + urls between reads. By default, old enclosures are deleted and replaced with new ones. + Set this to true, to retain old enclosures - they will have their ``is_current`` flag + set to ``False`` +- ``SAVE_JSON`` (Default False) + - If set, Sources and Posts will store a JSON representation of the all the data retrieved + from the feed so that uncommon or custom attributes can be retrieved. Caution - this will + dramatically increase tha amount of space used in your database. + + Basic Models ------------ @@ -124,13 +141,3 @@ There are two helper methods in the ``utils`` module to help manage subscription parent is None. ``get_unread_subscription_list_for_user`` will do the same but only returns Subscriptions that are unread or that have unread children if they are a folder. -Dealing with Cloudflare ------------------------ - -Depending on where you run your server, you may run into problems with Cloudflare's web captcha. Plenty of sites out there set up their Cloudflare to have default security on their RSS feed and this can block server-side RSS readers. - -It's a huge pain and affects lots of self-hosted RSS readers. Seriously, Google it. - -``django-feed-reader`` will do it's utmost to get these feeds anyway through the judicious use of public proxy servers, but is haphazard and you cannot rely on the scheduling of such feeds. - -Feeds blocked by Cloudflare will have the ``is_cloudflare`` flag set on their ``Source`` and will update on a best-efforts basis. diff --git a/readme.rst b/readme.rst index c815516..1fdbd68 100644 --- a/readme.rst +++ b/readme.rst @@ -124,15 +124,6 @@ There are two helper methods in the ``utils`` module to help manage subscription parent is None. ``get_unread_subscription_list_for_user`` will do the same but only returns Subscriptions that are unread or that have unread children if they are a folder. -Dealing with Cloudflare ------------------------ -Depending on where you run your server, you may run into problems with Cloudflare's web captcha. Plenty of sites out there set up their Cloudflare to have default security on their RSS feed and this can block server-side RSS readers. - -It's a huge pain and affects lots of self-hosted RSS readers. Seriously, Google it. - -``django-feed-reader`` will do it's utmost to get these feeds anyway through the judicious use of public proxy servers, but is haphazard and you cannot rely on the scheduling of such feeds. - -Feeds blocked by Cloudflare will have the ``is_cloudflare`` flag set on their ``Source`` and will update on a best-efforts basis. For more details see the `full documentation `_. diff --git a/setup.py b/setup.py index 22331e5..2bd8cd4 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ setuptools.setup( name='django-feed-reader', - version='2.0.0-beta.2', + version='2.0.0', description='An RSS feed reading library for Django.', long_description=long_description, long_description_content_type='text/markdown',