Metadata-Version: 1.1
Name: aws.authrss
Version: 2.0.0
Summary: Private Plone RSS feeds through a user private token
Home-page: http://pypi.python.org/pypi/aws.authrss
Author: Gilles Lenfant
Author-email: gilles.lenfant@alterway.fr
License: GPL
Description: ===========
        aws.authrss
        ===========
        
        Access your Plone RSS feeds as authenticated user. This feature was inspired by
        `Redmine <http://www.redmine.org/>`_.
        
        Abstract
        ========
        
        Actually, authenticated users in Plone site may read content that are not
        available to anonymous users. But when subscribing to a Plone RSS feed they can
        only view items that are available to anonymous users. Just because the RSS
        readers such as Google Reader do not - and cannot - provide feature to provide
        authentication cookie or header to authenticate on the feed URL.
        
        ``aws.authrss`` gives to the authenticated users a dedicated and private link to
        the Plone RSS feeds. Such feeds provide all elements the user is entitled to
        view, when authenticated in the Plone site with a browser, and of course,
        relevant to the feed (Folder, Collection, ...)
        
        Each user may have a private token he can change whenever he wants in his
        personal preferences. This token is part of the query string of the
        authenticated RSS feed, and identifies the user **only** for the RSS feeds.
        
        A control panel for site administrators gives the possibility to prune private
        tokens of removed users.
        
        Plays with
        ==========
        
        The module supports Plone 4.3 and 5.0.
        
        
        .. admonition::
           Conflicts with...
        
           `collective.blog.feeds <http://pypi.python.org/pypi/collective.blog.feeds>`_
           because both override the same viewlet, and there's no possible conflict
           resolution. Sorry.
        
        Installation
        ============
        
        Production site
        ---------------
        
        As usual in your ``zc.buildout`` configuration: ::
        
          [instance]
          recipe = plone.recipe.zope2instance
          ...
          eggs =
              aws.authrss
        
        Development site
        ----------------
        
        The development package at Github comes with a suitable ``buildout.cfg``. See
        `Links`_. You just need to clone that repository and play the usual ``python
        bootstrap.py`` + ``bin/buildout``.
        
        In Site Setup
        -------------
        
        Don't forget to enable syndication in the Syndication control panel
        and to check the ``Show feed link`` checkbox.
        
        Upgrading
        =========
        
        Available upgrades may be executed from the ``portal_setup`` tool of your Plone
        site in the **Upgrades** tab.
        
        .. admonition::
           No upgrades with alpha releases
        
           For the first alpha versions, we shall not provide upgrade steps. You will
           need to reinstall the component. Stable versions coming after the first
           stable versions will come will all necessary upgrade steps.
        
        Customization
        =============
        
        Integrators
        -----------
        
        ``aws.authrss`` overrides the ``portal_actions/document_actions/rss`` action
        to add the authenticated RSS link in your site.
        
        Developers
        ----------
        
        ``aws.authrss`` comes with its own tokens manager that stores tokens in an
        ``OOBtree``. See the class ``aws.authrss.tokenmanager.DefaultTokenManager``.
        
        You may provide your own tokens manager registering an utility that implements
        ``aws.authrss.interfaces.ITokenManager`` in your component's
        ``override.zcml``. Then install this local utility using a GenericSetup
        ``componentregistry.xml`` file like this one: ::
        
          <?xml version="1.0"?>
          <componentregistry>
            <utilities>
              <utility
                interface="aws.authrss.interfaces.ITokenManager"
                factory="my.component.tokenmanager.DefaultTokenManager"
               />
            </utilities>
          </componentregistry>
        
        Credits
        =======
        
        This Plone component is sponsored by `Alter Way <http://www.alterway.fr/>`_
        
        Links
        =====
        
        At github.com (contributors)
          https://github.com/glenfant/aws.authrss
        
        At pypi (integrators)
          http://pypi.python.org/pypi/aws.authrss
        
        Planned features
        ================
        
        Do not assign tokens to users authenticated from an user folder that's not in
        the Plone site (i.e a Zope root manager).
        
        Contributors
        ============
        
        
        * `Gilles Lenfant <gilles.lenfant_AT_alterway.fr>`_: Main developer and french
          translation
        
        Changelog
        =========
        
        2.0.0 (2016-11-21)
        ------------------
        
        - Drop support for Plone < 4.3 and Python 2.6. Add compatibility for
          Plone 4.3 and 5.0 on Python 2.7.
          [vincentfretin]
        
        1.0.0b2
        -------
        
        - Fixed packaging issue with MANIFEST.in
          [glenfant]
        
        1.0.0b1
        -------
        
        - Added support for search results
          [glenfant]
        
        
        1.0.0a2
        -------
        
        - Fixed packaging issues.
          [glenfant]
        
        1.0.0a1
        -------
        
        - First public version
          [glenfant]
        
Keywords: plone rss
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 2.7
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Framework :: Plone :: 5.0
Classifier: Natural Language :: English
Classifier: Natural Language :: French
