Skip to content

Generates a feed providing the latest comments of a Shaarli instance having Isso plugin

License

Notifications You must be signed in to change notification settings

coded-with-claws/shaarli_isso_comments_feed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Generates a feed of the comments posted on a Shaarli website with Isso plugin

This tool addresses the following situation:

  • Shaarli provides a feed (atom + RSS) for the latest shaares
  • Isso provides an API listing the latest comments but only in JSON format (not in atom / RSS formats)
    → This tools generates a feed listing the new comments, quoting the associated shaare title.
    → You then have to move those feed files to the shaarli webserver instance so that they are available to users.

The feed is generated based on the Isso API "/latest", then enriched with the title of the shaares. The generated files are in Atom and RSS formats.

BEWARE:

  • The Isso API "/latest" gives all comments, included those related to private shaares.
  • All my code is coded with claws :) (it's dirty yet it works)

Pre-requisites:

  • Python3 (tested on 3.7.3), preferably with virtual environment support
  • Shaarli (tested on v0.12.1) with the Isso plugin working
  • Isso server (tested on v0.12.4) with the "latest-enabled" option enabled (isso-comments/isso#610 / isso-comments/isso#556)
  • The isso API "/latest" is expected to be in the path "<shaarli_context>/isso/latest"

Usage:

  • Call main.py with the needed arguments (for example with cron)
  • Copy the atom.xml and rss.xml generated files into your webserver directory (for example with cron & sudo)
  • Make sure you don't enable caching (client side) of those files

About

Generates a feed providing the latest comments of a Shaarli instance having Isso plugin

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages