Documentation and license

feedgenerator/__init__.py

@@ -9,7 +9,7 @@
 	extension for Podcasts.
 
 	:copyright: 2013 by Lars Kiesow
-	:license: FreeBSD and LGPL, see LICENSE for more details.
+	:license: FreeBSD and LGPL, see license.* for more details.
 
 
 	-------------

feedgenerator/__main__.py

@@ -6,7 +6,7 @@
 
 	:copyright: 2013, Lars Kiesow <lkiesow@uos.de>
 
-	:license: FreeBSD and LGPL, see LICENSE for more details.
+	:license: FreeBSD and LGPL, see license.* for more details.
 '''
 
 from feedgenerator.feed import FeedGenerator

feedgenerator/entry.py

@@ -6,7 +6,7 @@
 
 	:copyright: 2013, Lars Kiesow <lkiesow@uos.de>
 
-	:license: FreeBSD and LGPL, see LICENSE for more details.
+	:license: FreeBSD and LGPL, see license.* for more details.
 '''
 
 from lxml import etree

feedgenerator/feed.py

@@ -6,7 +6,7 @@
 
 	:copyright: 2013, Lars Kiesow <lkiesow@uos.de>
 
-	:license: FreeBSD and LGPL, see LICENSE for more details.
+	:license: FreeBSD and LGPL, see license.* for more details.
 '''
 
 from lxml import etree

feedgenerator/podcast.py

@@ -8,7 +8,7 @@
 
 	:copyright: 2013, Lars Kiesow <lkiesow@uos.de>
 
-	:license: FreeBSD and LGPL, see LICENSE for more details.
+	:license: FreeBSD and LGPL, see license.* for more details.
 '''
 
 from lxml import etree

feedgenerator/podcast_entry.py

@@ -8,7 +8,7 @@
 
 	:copyright: 2013, Lars Kiesow <lkiesow@uos.de>
 
-	:license: FreeBSD and LGPL, see LICENSE for more details.
+	:license: FreeBSD and LGPL, see license.* for more details.
 '''
 
 from lxml import etree

feedgenerator/util.py

@@ -7,8 +7,7 @@
 	This file contains helper functions for the feed generator module.
 
 	:copyright: 2013, Lars Kiesow <lkiesow@uos.de>
-
+	:license: FreeBSD and LGPL, see license.* for more details.
-	:license: FreeBSD and LGPL, see LICENSE for more details.
 '''
 
 

license.bsd

@@ -0,0 +1,31 @@
+
+Copyright 2011 Lars Kiesow. All rights reserved.
+http://www.larskiesow.de
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation
+are those of the authors and should not be interpreted as representing
+official policies, either expressed or implied, of everyone working on
+this project.

license.lgpl

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

readme.md

@@ -0,0 +1,104 @@
+=============
+feedgenerator
+=============
+
+This module can be used to generate web feeds in both ATOM and RSS format.
+They included PodcastGenerator furthermore includes all of Apples RSS
+extension for Podcasts.
+
+:copyright: 2013 by Lars Kiesow
+:license: FreeBSD and LGPL, see license.* for more details.
+
+
+-------------
+Create a Feed
+-------------
+
+To create a feed simply instanciate the FeedGenerator class and insert some
+data::
+
+	>>> from feedgenerator.feed import FeedGenerator
+	>>> fg = FeedGenerator()
+	>>> fg.id('http://lernfunk.de/media/654321')
+	>>> fg.title('Some Testfeed')
+	>>> fg.author( {'name':'John Doe','email':'john@example.de'} )
+	>>> fg.link( href='http://example.com', rel='alternate' )
+	>>> fg.logo('http://ex.com/logo.jpg')
+	>>> fg.subtitle('This is a cool feed!')
+	>>> fg.link( href='http://larskiesow.de/test.atom', rel='self' )
+	>>> fg.language('en')
+
+Note that for the methods which set fields that can occur more than once in
+a feed you can use all of the following ways to provide data:
+
+- Provide the data for that element as keyword arguments::
+- Provide the data for that element as dictionary::
+- Provide a list of dictionaries with the data for several elements::
+
+Example::
+
+	>>> fg.contributor( name='John Doe', email='jdoe@example.com' )
+	>>> fg.contributor({'name':'John Doe', 'email':'jdoe@example.com'})
+	>>> fg.contributor([{'name':'John Doe', 'email':'jdoe@example.com'}, ...])
+
+-----------------
+Generate the Feed
+-----------------
+
+After that you can generate both RSS or ATOM by calling the respective method::
+
+	>>> atomfeed = fg.atom_str(pretty=True) # Get the ATOM feed as string
+	>>> rssfeed  = fg.rss_str(pretty=True) # Get the RSS feed as string
+	>>> fg.atom_file('atom.xml') # Write the ATOM feed to a file
+	>>> fg.rss_file('rss.xml') # Write the RSS feed to a file
+
+
+----------------
+Add Feed Entries
+----------------
+
+To add entries (items) to a feed you need to create new FeedEntry objects
+and append them to the list of entries in the FeedGenerator. The most
+convenient way to go is to use the FeedGenerator itself for the
+instantiation of the FeedEntry object::
+
+	>>> fe = fg.add_entry()
+	>>> fe.id('http://lernfunk.de/media/654321/1')
+	>>> fe.title('The First Episode')
+
+The FeedGenerators method add_entry(...) without argument provides will
+automaticall generate a new FeedEntry object, append it to the feeds
+internal list of entries and return it, so that additional data can be
+added.
+
+-----------------
+Produce a Podcast
+-----------------
+
+A podcast is an RSS feed with some additional elements for ITunes. The
+feedgenerator has a PodcastGenerator class as extension to the default
+FeedGenerator which you can use to set these additional fields.
+
+To produce a podcast simply do something like this::
+
+	>>> from feedgenerator.podcast import PodcastGenerator
+	>>> fg = PodcastGenerator()
+	...
+	>>> fg.podcast_str(pretty=True)
+	>>> fg.podcast_file('podcast.xml')
+
+For the episodes of the podcast you should also use PodcastEntry instead of
+FeedEntry. However, if you use the add_entry(...) method to generator the
+entry objects, it will take care of that for you.
+
+Of cause you can still produce a normat ATOM or RSS feed, even if you use
+the PodcastGenerator using the {atom,rss}_{str,file} methods.
+
+---------------------
+Testing the Generator
+---------------------
+
+You can test the module by simply executing::
+
+	%> pythom -m feedgenerator 
+