Metadata-Version: 2.0
Name: devpi-rss
Version: 1.0.9
Summary: A plug-in for devpi-server which generates RSS feeds for indices.
Home-page: https://github.com/k-bu/devpi-rss
Author: k-bu
Author-email: k-bu@email.com
License: MIT
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: PyRSS2Gen
Requires-Dist: devpi-server (>=2.2.2)
Requires-Dist: devpi-web (>=2.4.0)

=========
devpi-rss
=========

devpi-rss is a plug-in for `devpi-server <http://doc.devpi.net>`_ which generates RSS feeds for
devpi indices.

.. image:: screenshot.png
   :alt: Screenshot
   :target: center

Requirements
------------

.. code::

   devpi-server >= 2.2.2
   devpi-web >= 2.4.0

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

.. code::

   pip install devpi-rss

When the devpi-server gets started without a custom theme (without passing the ``--theme``
parameter), then no further configuration is required, since devpi-rss overwrites the
``templates/macro.pt`` of the default theme in order to make the RSS button visible. If you use a
custom theme, then you have to manually apply the content of ``devpi-rss/templates/macro.pt`` into
your theme.

Usage
-----

By default every single index generates its own RSS feed, but an RSS feed can be activated or
deactivated by modifying the regarding index property:

.. code::

   devpi-server index someuser/someindex rss_active=True

or

.. code::

   devpi-server index someuser/someindex rss_active=False

Additional devpi-server commandline options:

.. code::

  --rss-max-items RSS_MAX_ITEMS
                        maximum number of stored feed items [50]
  --rss-truncate-desc   do not let descriptions exceed 32 lines or 1024
                        characters
  --rss-no-auto         do not automatically activate rss for new indices


1.0.9
-----

- fix for python3.4 (thx to kelnmaari)

1.0.8
-----

- fix xml declaration ('utf-8' instead of 'utf8')

1.0.7
-----

- fix callback signature (projectname -> project) (required for recent pluggy version)


