Mario Lang b35996ca43 Allow for an optional maximum number of entries to display. 11 years ago
..
Readme.rst b35996ca43 Allow for an optional maximum number of entries to display. 11 years ago
__init__.py 9e70c17839 import plugins from core and restructure repo 11 years ago
github_activity.py b35996ca43 Allow for an optional maximum number of entries to display. 11 years ago

Readme.rst

GitHub activity
---------------

This plugin makes use of the `feedparser`_ library that you'll need to
install.

Set the ``GITHUB_ACTIVITY_FEED`` parameter to your GitHub activity feed.
For example, to track Pelican project activity, the setting would be::

GITHUB_ACTIVITY_FEED = 'https://github.com/getpelican.atom'

If you want to limit the amount of entries to a certain maximum set the
``GITHUB_ACTIVITY_MAX_ENTRIES`` parameter.

GITHUB_ACTIVITY_MAX_ENTRIES = 10

On the template side, you just have to iterate over the ``github_activity``
variable, as in this example::

{% if GITHUB_ACTIVITY_FEED %}

Github Activity




    {% for entry in github_activity %}
  • {{ entry[0] }}
    {{ entry[1] }}

  • {% endfor %}


{% endif %}

``github_activity`` is a list of lists. The first element is the title,
and the second element is the raw HTML from GitHub.

.. _feedparser: https://crate.io/packages/feedparser/