Skip to content
Branch: master
Find file History
talha131 Update article_generate_context to article_generator_context
getpelican/pelican@f2d6f77 changed
`article_generate_context` to `article_generator_context`. This commit
updates the plugin to reflect the change.
Latest commit d3495d0 Aug 11, 2013

Readme.md

Goodreads Activity

A Pelican plugin to lists books from your Goodreads shelves.

Copyright (c) Talha Mansoor

Author Talha Mansoor
Author Email talha131@gmail.com
Author Homepage http://onCrashReboot.com
Github Account https://github.com/talha131

Credits

This plugin is inspired by Marco Milanesi kpanic@gnufunk.org Github activity plugin.

Requirements

goodreads_activity requires feedparser.

pip install feedparser

How to Use

Important Unlike Marco's Github activity plugin, this plugin returns a dictionary composed of the books in your Goodreads shelf and their details.

To enable it, set GOODREADS_ACTIVITY_FEED in your pelican config file. It should point to the activity feed of your bookshelf.

To find your self's activity feed,

  1. Open Goodreads homepage and login
  2. Click on My Books in the top navigational bar
  3. Select the bookshelf you are interested in from the left hand column
  4. Look for RSS link in the footer. Copy it's link.

Here is an example feed of currently-reading shelf,

GOODREADS_ACTIVITY_FEED='http://www.goodreads.com/review/list_rss/8028663?key=b025l3000336epw1pix047e853agggannc9932ed&shelf=currently-reading'

You can access the goodreads_activity in your Jinja2 template. goodreads_activity is a dictionary. Its valid keys are

  1. shelf_title it has the title of your shelf
  2. books it is an array of book dictionary

Valid keys for book dictionary are

  1. title
  2. author
  3. link link to your book review
  4. l_cover large cover
  5. m_cover medium cover
  6. s_cover small cover
  7. description
  8. rating
  9. review
  10. tags

Template Example

{% if GOODREADS_ACTIVITY_FEED %}
    <h2>{{ goodreads_activity.shelf_title }}</h2>
    {% for book in goodreads_activity.books %}
        <img src="{{book.s_cover}}"/>
        <header>{{book.title}}<small> by {{book.author}}</small></header>
        <article>{{book.description|truncate(end='')}}
        <a href={{book.link}} target="_blank">...more</a></article>
    {% endfor %}
{% endif %}
You can’t perform that action at this time.