[Plone-cvs] r24019 - review/plip197-feedparser

[Maurits v. R. <svn...@pl...>]

Author: maurits
Date: Wed Dec 31 16:14:02 2008
New Revision: 24019

Modified:
   review/plip197-feedparser/README.txt
Log:
Fleshed out the readme.

Modified: review/plip197-feedparser/README.txt
==============================================================================
--- review/plip197-feedparser/README.txt	(original)
+++ review/plip197-feedparser/README.txt	Wed Dec 31 16:14:02 2008
@@ -1,16 +1,26 @@
-Plone 3.3 review bundles
-========================
+PLIP 197: Add FeedParser as external requirement instead of shipping with it 
+============================================================================
 
-Please use this buildout as a base/template for your Plone 3.3 review
-bundles.  Since it is using `buildout.eggtractor`, your changes should
-normally boil down to adding your PLIP-specific branches to the `src/`
-directory as svn:externals.
+See http://plone.org/products/plone/roadmap/197
 
-So to use this buildout simply copy it like::
+Basically the only thing that needs doing is:
 
-  $ svn copy https://svn.plone.org/svn/plone/review/3.3-review-bundle-buildout \
-             https://svn.plone.org/svn/plone/review/plip241-auto-sort-cleanup
+- Remove portlets/feedparser.py from plone.app.portlets.
 
-and go from there.  If you have questions please don't hesitate the
-framework team via its mailing list or IRC channel.
+- Instead add FeedParser as requirement in setup.py.
 
+This has been done on this branch (see src/plone.app.portlets in this
+buildout):
+
+    https://svn.plone.org/svn/plone/plone.app.portlets/branches/plip197-feedparser-as-external-egg
+
+
+One possible gotcha is that the *package* is called ``FeedParser`` and
+the *module* contained in that package is called ``feedparser``.
+``easy_install`` can handle both spellings just fine.  But I once
+encountered problems when using the lowercased name in setup.py.  See
+http://dev.plone.org/plone/ticket/7299 (which is where this plip
+originated).  It could not reproduce that later, but I say we call the
+dependency ``FeedFeeder`` and everything should work.
+
+Maurits van Rees