From 1f41347cbe41ce1846960f1c97c6d703cafe0aed Mon Sep 17 00:00:00 2001 From: Lars Kiesow Date: Sun, 5 May 2013 23:24:11 +0200 Subject: [PATCH] Documentation for v0.2.2 --- api.entry.html | 8 +- api.feed.html | 8 +- api.html | 8 +- api.util.html | 8 +- ext/api.ext.base.html | 135 ++++++++++++++ ext/api.ext.podcast.html | 322 +++++++++++++++++++++++++++++++++ ext/api.ext.podcast_entry.html | 300 ++++++++++++++++++++++++++++++ genindex.html | 8 +- index.html | 14 +- py-modindex.html | 8 +- search.html | 8 +- 11 files changed, 792 insertions(+), 35 deletions(-) create mode 100644 ext/api.ext.base.html create mode 100644 ext/api.ext.podcast.html create mode 100644 ext/api.ext.podcast_entry.html diff --git a/api.entry.html b/api.entry.html index bdb8942..806ae69 100644 --- a/api.entry.html +++ b/api.entry.html @@ -8,7 +8,7 @@ - feedgen.entry — pyFeedGen 0.1.s20130505 documentation + feedgen.entry — pyFeedGen 0.2.2 documentation @@ -17,7 +17,7 @@ - +

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

feedgen.entry

diff --git a/api.feed.html b/api.feed.html index 9c04bdb..ecb916b 100644 --- a/api.feed.html +++ b/api.feed.html @@ -8,7 +8,7 @@ - feedgen.feed — pyFeedGen 0.1.s20130505 documentation + feedgen.feed — pyFeedGen 0.2.2 documentation @@ -17,7 +17,7 @@ - +

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

feedgen.feed

diff --git a/api.html b/api.html index 052e2ee..f5dd577 100644 --- a/api.html +++ b/api.html @@ -8,7 +8,7 @@ - API Documentation — pyFeedGen 0.1.s20130505 documentation + API Documentation — pyFeedGen 0.2.2 documentation @@ -17,7 +17,7 @@ - +

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

API Documentation

diff --git a/api.util.html b/api.util.html index 5e6f0f8..aed2cc0 100644 --- a/api.util.html +++ b/api.util.html @@ -8,7 +8,7 @@ - feedgen.util — pyFeedGen 0.1.s20130505 documentation + feedgen.util — pyFeedGen 0.2.2 documentation @@ -17,7 +17,7 @@ - +

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

feedgen.util

diff --git a/ext/api.ext.base.html b/ext/api.ext.base.html new file mode 100644 index 0000000..b06c3d6 --- /dev/null +++ b/ext/api.ext.base.html @@ -0,0 +1,135 @@ + + + + + + + + + + feedgen.ext.base — pyFeedGen 0.2.2 documentation + + + + + + + + + + + + + + + + +

+ pyFeedGen 0.2.2 documentation

+

feedgen.ext.base

+
+
+ +

+ «  feedgen.util +   ::   + Contents +   ::   + feedgen.ext.podcast  » +

+ +
+
+ + +
Contents
+
+

feedgen.ext.base

+

Basic FeedGenerator extension which does nothing but provides all necessary +methods.

+ +++ + + + + + +
copyright:2013, Lars Kiesow <lkiesow@uos.de>
license:FreeBSD and LGPL, see license.* for more details.
+
+
+class feedgen.ext.base.BaseEntryExtension
+

Basic FeedEntry extension.

+
+ +
+
+class feedgen.ext.base.BaseExtension
+

Basic FeedGenerator extension.

+
+
+extend_atom(feed, doc=None)
+

Create an ATOM feed xml structure containing all previously set +fields.

+ +++ + + + + + +
Parameters:feed – The feed xml root element.
Returns:The feed root element.
+
+ +
+
+extend_rss(feed)
+

Create an RSS feed xml structure containing all previously set fields.

+ +++ + + + + + +
Parameters:feed – The feed xml root element.
Returns:The feed root element.
+
+ +
+ +
+ + +
+
+ +

+ «  feedgen.util +   ::   + Contents +   ::   + feedgen.ext.podcast  » +

+ +
+ +
+ © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
+ + \ No newline at end of file diff --git a/ext/api.ext.podcast.html b/ext/api.ext.podcast.html new file mode 100644 index 0000000..3d73325 --- /dev/null +++ b/ext/api.ext.podcast.html @@ -0,0 +1,322 @@ + + + + + + + + + + feedgen.ext.podcast — pyFeedGen 0.2.2 documentation + + + + + + + + + + + + + + + + +

+ pyFeedGen 0.2.2 documentation

+

feedgen.ext.podcast

+
+
+ +

+ «  feedgen.ext.base +   ::   + Contents +   ::   + feedgen.ext.podcast_entry  » +

+ +
+
+ + +
Contents
+
+

feedgen.ext.podcast

+

Extends the FeedGenerator to produce podcasts.

+ +++ + + + + + +
copyright:2013, Lars Kiesow <lkiesow@uos.de>
license:FreeBSD and LGPL, see license.* for more details.
+
+
+class feedgen.ext.podcast.PodcastExtension
+

FeedGenerator extension for podcasts.

+
+
+extend_rss(rss_feed)
+

Create an RSS feed xml structure containing all previously set fields.

+ +++ + + + +
Returns:Tuple containing the feed root element and the element tree.
+
+ +
+
+itunes_author(itunes_author=None)
+

Get or set the itunes:author. The content of this tag is shown in the +Artist column in iTunes. If the tag is not present, iTunes uses the +contents of the <author> tag. If <itunes:author> is not present at the +feed level, iTunes will use the contents of <managingEditor>.

+ +++ + + + + + +
Parameters:itunes_author – The author of the podcast.
Returns:The author of the podcast.
+
+ +
+
+itunes_block(itunes_block=None)
+

Get or set the ITunes block attribute. Use this to prevent the entire +podcast from appearing in the iTunes podcast directory.

+ +++ + + + + + +
Parameters:itunes_block – Block the podcast.
Returns:If the podcast is blocked.
+
+ +
+
+itunes_category(itunes_category=None, itunes_subcategory=None)
+

Get or set the ITunes category which appears in the category column +and in iTunes Store Browser.

+

The (sub-)category has to be one from the values defined at +http://www.apple.com/itunes/podcasts/specs.html#categories

+ +++ + + + + + +
Parameters:
    +
  • itunes_category – Category of the podcast.
    • +
  • itunes_subcategory – Subcategory of the podcast.
    • +
+
Returns:

Category data of the podcast.

+
+
+ +
+
+itunes_complete(itunes_complete=None)
+

Get or set the itunes:complete value of the podcast. This tag can be +used to indicate the completion of a podcast.

+

If you populate this tag with “yes”, you are indicating that no more +episodes will be added to the podcast. If the <itunes:complete> tag is +present and has any other value (e.g. “no”), it will have no effect on +the podcast.

+ +++ + + + + + +
Parameters:itunes_complete – If the podcast is complete.
Returns:If the podcast is complete.
+
+ +
+
+itunes_explicit(itunes_explicit=None)
+

Get or the the itunes:explicit value of the podcast. This tag should +be used to indicate whether your podcast contains explicit material. The +three values for this tag are “yes”, “no”, and “clean”.

+

If you populate this tag with “yes”, an “explicit” parental advisory +graphic will appear next to your podcast artwork on the iTunes Store and +in the Name column in iTunes. If the value is “clean”, the parental +advisory type is considered Clean, meaning that no explicit language or +adult content is included anywhere in the episodes, and a “clean” graphic +will appear. If the explicit tag is present and has any other value +(e.g., “no”), you see no indicator — blank is the default advisory type.

+ +++ + + + + + +
Parameters:itunes_explicit – If the podcast contains explicit material.
Returns:If the podcast contains explicit material.
+
+ +
+
+itunes_image(itunes_image=None)
+

Get or set the image for the podcast. This tag specifies the artwork +for your podcast. Put the URL to the image in the href attribute. iTunes +prefers square .jpg images that are at least 1400x1400 pixels, which is +different from what is specified for the standard RSS image tag. In order +for a podcast to be eligible for an iTunes Store feature, the +accompanying image must be at least 1400x1400 pixels.

+

iTunes supports images in JPEG and PNG formats with an RGB color space +(CMYK is not supported). The URL must end in ”.jpg” or ”.png”. If the +<itunes:image> tag is not present, iTunes will use the contents of the +RSS image tag.

+

If you change your podcast’s image, also change the file’s name. iTunes +may not change the image if it checks your feed and the image URL is the +same. The server hosting your cover art image must allow HTTP head +requests for iTS to be able to automatically update your cover art.

+ +++ + + + + + +
Parameters:itunes_image – Image of the podcast.
Returns:Image of the podcast.
+
+ +
+
+itunes_new_feed_url(itunes_new_feed_url=None)
+

Get or set the new-feed-url property of the podcast. This tag allows +you to change the URL where the podcast feed is located

+

After adding the tag to your old feed, you should maintain the old feed +for 48 hours before retiring it. At that point, iTunes will have updated +the directory with the new feed URL.

+ +++ + + + + + +
Parameters:itunes_new_feed_url – New feed URL.
Returns:New feed URL.
+
+ +
+
+itunes_owner(name=None, email=None)
+

Get or set the itunes:owner of the podcast. This tag contains +information that will be used to contact the owner of the podcast for +communication specifically about the podcast. It will not be publicly +displayed.

+ +++ + + + + + +
Parameters:itunes_owner – The owner of the feed.
Returns:Data of the owner of the feed.
+
+ +
+
+itunes_subtitle(itunes_subtitle=None)
+

Get or set the itunes:subtitle value for the podcast. The contents of +this tag are shown in the Description column in iTunes. The subtitle +displays best if it is only a few words long.

+ +++ + + + + + +
Parameters:itunes_subtitle – Subtitle of the podcast.
Returns:Subtitle of the podcast.
+
+ +
+
+itunes_summary(itunes_summary=None)
+

Get or set the itunes:summary value for the podcast. The contents of +this tag are shown in a separate window that appears when the “circled i” +in the Description column is clicked. It also appears on the iTunes page +for your podcast. This field can be up to 4000 characters. If +<itunes:summary> is not included, the contents of the <description> tag +are used.

+ +++ + + + + + +
Parameters:itunes_summary – Summary of the podcast.
Returns:Summary of the podcast.
+
+ +
+ +
+ + +
+
+ +

+ «  feedgen.ext.base +   ::   + Contents +   ::   + feedgen.ext.podcast_entry  » +

+ +
+ +
+ © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
+ + \ No newline at end of file diff --git a/ext/api.ext.podcast_entry.html b/ext/api.ext.podcast_entry.html new file mode 100644 index 0000000..29309ac --- /dev/null +++ b/ext/api.ext.podcast_entry.html @@ -0,0 +1,300 @@ + + + + + + + + + + feedgen.ext.podcast_entry — pyFeedGen 0.2.2 documentation + + + + + + + + + + + + + + + +

+ pyFeedGen 0.2.2 documentation

+

feedgen.ext.podcast_entry

+
+
+ +

+ «  feedgen.ext.podcast +   ::   + Contents +

+ +
+
+ + +
Contents
+
+

feedgen.ext.podcast_entry

+

Extends the feedgen to produce podcasts.

+ +++ + + + + + +
copyright:2013, Lars Kiesow <lkiesow@uos.de>
license:FreeBSD and LGPL, see license.* for more details.
+
+
+class feedgen.ext.podcast_entry.PodcastEntryExtension
+

FeedEntry extension for podcasts.

+
+
+extend_rss(entry)
+

Add additional fields to an RSS item.

+ +++ + + + +
Parameters:feed – The RSS item XML element to use.
+
+ +
+
+itunes_author(itunes_author=None)
+

Get or set the itunes:author of the podcast episode. The content of +this tag is shown in the Artist column in iTunes. If the tag is not +present, iTunes uses the contents of the <author> tag. If <itunes:author> +is not present at the feed level, iTunes will use the contents of +<managingEditor>.

+ +++ + + + + + +
Parameters:itunes_author – The author of the podcast.
Returns:The author of the podcast.
+
+ +
+
+itunes_block(itunes_block=None)
+

Get or set the ITunes block attribute. Use this to prevent episodes +from appearing in the iTunes podcast directory.

+ +++ + + + + + +
Parameters:itunes_block – Block podcast episodes.
Returns:If the podcast episode is blocked.
+
+ +
+
+itunes_duration(itunes_duration=None)
+

Get or set the duration of the podcast episode. The content of this +tag is shown in the Time column in iTunes.

+

The tag can be formatted HH:MM:SS, H:MM:SS, MM:SS, or M:SS (H = hours, +M = minutes, S = seconds). If an integer is provided (no colon present), +the value is assumed to be in seconds. If one colon is present, the +number to the left is assumed to be minutes, and the number to the right +is assumed to be seconds. If more than two colons are present, the +numbers farthest to the right are ignored.

+ +++ + + + + + +
Parameters:itunes_duration – Duration of the podcast episode.
Returns:Duration of the podcast episode.
+
+ +
+
+itunes_explicit(itunes_explicit=None)
+

Get or the the itunes:explicit value of the podcast episode. This tag +should be used to indicate whether your podcast episode contains explicit +material. The three values for this tag are “yes”, “no”, and “clean”.

+

If you populate this tag with “yes”, an “explicit” parental advisory +graphic will appear next to your podcast artwork on the iTunes Store and +in the Name column in iTunes. If the value is “clean”, the parental +advisory type is considered Clean, meaning that no explicit language or +adult content is included anywhere in the episodes, and a “clean” graphic +will appear. If the explicit tag is present and has any other value +(e.g., “no”), you see no indicator — blank is the default advisory type.

+ +++ + + + + + +
Parameters:itunes_explicit – If the podcast episode contains explicit material.
Returns:If the podcast episode contains explicit material.
+
+ +
+
+itunes_image(itunes_image=None)
+

Get or set the image for the podcast episode. This tag specifies the +artwork for your podcast. Put the URL to the image in the href attribute. +iTunes prefers square .jpg images that are at least 1400x1400 pixels, +which is different from what is specified for the standard RSS image tag. +In order for a podcast to be eligible for an iTunes Store feature, the +accompanying image must be at least 1400x1400 pixels.

+

iTunes supports images in JPEG and PNG formats with an RGB color space +(CMYK is not supported). The URL must end in ”.jpg” or ”.png”. If the +<itunes:image> tag is not present, iTunes will use the contents of the +RSS image tag.

+

If you change your podcast’s image, also change the file’s name. iTunes +may not change the image if it checks your feed and the image URL is the +same. The server hosting your cover art image must allow HTTP head +requests for iTS to be able to automatically update your cover art.

+ +++ + + + + + +
Parameters:itunes_image – Image of the podcast.
Returns:Image of the podcast.
+
+ +
+
+itunes_is_closed_captioned(itunes_is_closed_captioned=None)
+

Get or set the is_closed_captioned value of the podcast episode. This +tag should be used if your podcast includes a video episode with embedded +closed captioning support. The two values for this tag are “yes” and +“no”.

+ +++ + + + + + +
Parameters:is_closed_captioned – If the episode has closed captioning support.
Returns:If the episode has closed captioning support.
+
+ +
+
+itunes_order(itunes_order=None)
+

Get or set the itunes:order value of the podcast episode. This tag can +be used to override the default ordering of episodes on the store.

+

This tag is used at an <item> level by populating with the number value +in which you would like the episode to appear on the store. For example, +if you would like an <item> to appear as the first episode in the +podcast, you would populate the <itunes:order> tag with “1”. If +conflicting order values are present in multiple episodes, the store will +use default ordering (pubDate).

+

To remove the order from the episode set the order to a value below zero.

+ +++ + + + + + +
Parameters:itunes_order – The order of the episode.
Returns:The order of the episode.
+
+ +
+
+itunes_subtitle(itunes_subtitle=None)
+

Get or set the itunes:subtitle value for the podcast episode. The +contents of this tag are shown in the Description column in iTunes. The +subtitle displays best if it is only a few words long.

+ +++ + + + + + +
Parameters:itunes_subtitle – Subtitle of the podcast episode.
Returns:Subtitle of the podcast episode.
+
+ +
+
+itunes_summary(itunes_summary=None)
+

Get or set the itunes:summary value for the podcast episode. The +contents of this tag are shown in a separate window that appears when the +“circled i” in the Description column is clicked. It also appears on the +iTunes page for your podcast. This field can be up to 4000 characters. If +<itunes:summary> is not included, the contents of the <description> tag +are used.

+ +++ + + + + + +
Parameters:itunes_summary – Summary of the podcast episode.
Returns:Summary of the podcast episode.
+
+ +
+ +
+ + +
+
+ +

+ «  feedgen.ext.podcast +   ::   + Contents +

+ +
+ +
+ © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
+ + \ No newline at end of file diff --git a/genindex.html b/genindex.html index 96b2fa7..ef26beb 100644 --- a/genindex.html +++ b/genindex.html @@ -10,7 +10,7 @@ - Index — pyFeedGen 0.1.s20130505 documentation + Index — pyFeedGen 0.2.2 documentation @@ -19,7 +19,7 @@ - +

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

Index

diff --git a/index.html b/index.html index 874c0e7..aba7258 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - Feedgenerator — pyFeedGen 0.1.s20130505 documentation + Feedgenerator — pyFeedGen 0.2.2 documentation @@ -17,7 +17,7 @@ - +

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

Feedgenerator

@@ -77,15 +77,15 @@ at license.bsd and license.lgpl.

If you are running Fedora Linux, Redhat Enterprise Linux, CentOS or Scientific linux you can use one of the following packages:

Simply download the file and run:

$ yum localinstall python-feedgen-0.1-1.fc17.noarch.rpm

If you want to build RPMs for other distributions you can use the following Source RPM:

Using pip

You can also use pip to install the feedgen module. Simply run:

diff --git a/py-modindex.html b/py-modindex.html index 78dd400..2dd9800 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -8,7 +8,7 @@ - Python Module Index — pyFeedGen 0.1.s20130505 documentation + Python Module Index — pyFeedGen 0.2.2 documentation @@ -17,7 +17,7 @@ - +

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

Python Module Index

diff --git a/search.html b/search.html index 44d6ef2..8adcdab 100644 --- a/search.html +++ b/search.html @@ -8,7 +8,7 @@ - Search — pyFeedGen 0.1.s20130505 documentation + Search — pyFeedGen 0.2.2 documentation @@ -17,7 +17,7 @@ - + @@ -37,7 +37,7 @@

- pyFeedGen 0.1.s20130505 documentation

+ pyFeedGen 0.2.2 documentation

Search