347 lines
No EOL
19 KiB
HTML
347 lines
No EOL
19 KiB
HTML
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<title>feedgen.ext.podcast — python-feedgen 0.8.0 documentation</title>
|
||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
||
<link rel="prev" title="feedgen.ext.dc" href="api.ext.dc.html" />
|
||
</head><body>
|
||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||
<h2 class="heading"><span>feedgen.ext.podcast</span></h2>
|
||
</div>
|
||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||
|
||
<p>
|
||
«  <a href="api.ext.dc.html">feedgen.ext.dc</a>
|
||
  ::  
|
||
<a class="uplink" href="../index.html">Contents</a>
|
||
  ::  
|
||
<a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>  »
|
||
</p>
|
||
|
||
</div>
|
||
<div class="content">
|
||
|
||
|
||
<script type=application/javascript src=_static/theme_extras.js></script>
|
||
<div class="apititle"><b>Contents</b></div>
|
||
<div class="apitoc"></div><span class="target" id="module-feedgen.ext.podcast"></span><div class="section" id="feedgen-ext-podcast">
|
||
<h1>feedgen.ext.podcast<a class="headerlink" href="#feedgen-ext-podcast" title="Permalink to this headline">¶</a></h1>
|
||
<p>Extends the FeedGenerator to produce podcasts.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">2013, Lars Kiesow <<a class="reference external" href="mailto:lkiesow%40uos.de">lkiesow<span>@</span>uos<span>.</span>de</a>></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">license:</th><td class="field-body">FreeBSD and LGPL, see license.* for more details.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="class">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension">
|
||
<em class="property">class </em><code class="descclassname">feedgen.ext.podcast.</code><code class="descname">PodcastExtension</code><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>FeedGenerator extension for podcasts.</p>
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.extend_ns">
|
||
<code class="descname">extend_ns</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.extend_ns" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a dict that will be used in the namespace map for the feed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.extend_rss">
|
||
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>rss_feed</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Extend an RSS feed root with set itunes fields.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The feed root element.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_author">
|
||
<code class="descname">itunes_author</code><span class="sig-paren">(</span><em>itunes_author=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_author" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_author</strong> – The author of the podcast.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The author of the podcast.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_block">
|
||
<code class="descname">itunes_block</code><span class="sig-paren">(</span><em>itunes_block=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_block" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the ITunes block attribute. Use this to prevent the
|
||
entire podcast from appearing in the iTunes podcast directory.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_block</strong> – Block the podcast.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast is blocked.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_category">
|
||
<code class="descname">itunes_category</code><span class="sig-paren">(</span><em>itunes_category=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the ITunes category which appears in the category column
|
||
and in iTunes Store Browser.</p>
|
||
<p>The (sub-)category has to be one from the values defined at
|
||
<a class="reference external" href="http://www.apple.com/itunes/podcasts/specs.html#categories">http://www.apple.com/itunes/podcasts/specs.html#categories</a></p>
|
||
<p>This method can be called with:</p>
|
||
<ul class="simple">
|
||
<li>the fields of an itunes_category as keyword arguments</li>
|
||
<li>the fields of an itunes_category as a dictionary</li>
|
||
<li>a list of dictionaries containing the itunes_category fields</li>
|
||
</ul>
|
||
<p>An itunes_category has the following fields:</p>
|
||
<ul class="simple">
|
||
<li><em>cat</em> name for a category.</li>
|
||
<li><em>sub</em> name for a subcategory, child of category</li>
|
||
</ul>
|
||
<p>If a podcast has more than one subcategory from the same category, the
|
||
category is called more than once.</p>
|
||
<p>Likei the parameter:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[{</span><span class="s2">"cat"</span><span class="p">:</span><span class="s2">"Arts"</span><span class="p">,</span><span class="s2">"sub"</span><span class="p">:</span><span class="s2">"Design"</span><span class="p">},{</span><span class="s2">"cat"</span><span class="p">:</span><span class="s2">"Arts"</span><span class="p">,</span><span class="s2">"sub"</span><span class="p">:</span><span class="s2">"Food"</span><span class="p">}]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>…would become:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span> <span class="n">text</span><span class="o">=</span><span class="s2">"Arts"</span><span class="o">></span>
|
||
<span class="o"><</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span> <span class="n">text</span><span class="o">=</span><span class="s2">"Design"</span><span class="o">/></span>
|
||
<span class="o"><</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span> <span class="n">text</span><span class="o">=</span><span class="s2">"Food"</span><span class="o">/></span>
|
||
<span class="o"></</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span><span class="o">></span>
|
||
</pre></div>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>itunes_category</strong> – Dictionary or list of dictionaries with
|
||
itunes_category data.</li>
|
||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">List of itunes_categories as dictionaries.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>—</p>
|
||
<p><strong>Important note about deprecated parameter syntax:</strong> Old version of
|
||
the feedgen did only support one category plus one subcategory which
|
||
would be passed to this ducntion as first two parameters. For
|
||
compatibility reasons, this still works but should not be used any may
|
||
be removed at any time.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_complete">
|
||
<code class="descname">itunes_complete</code><span class="sig-paren">(</span><em>itunes_complete=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_complete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the itunes:complete value of the podcast. This tag can be
|
||
used to indicate the completion of a podcast.</p>
|
||
<p>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.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_complete</strong> – If the podcast is complete.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast is complete.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_explicit">
|
||
<code class="descname">itunes_explicit</code><span class="sig-paren">(</span><em>itunes_explicit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_explicit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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”.</p>
|
||
<p>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.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_explicit</strong> – If the podcast contains explicit material.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast contains explicit material.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_image">
|
||
<code class="descname">itunes_image</code><span class="sig-paren">(</span><em>itunes_image=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_image" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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.</p>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_image</strong> – Image of the podcast.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Image of the podcast.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_new_feed_url">
|
||
<code class="descname">itunes_new_feed_url</code><span class="sig-paren">(</span><em>itunes_new_feed_url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_new_feed_url" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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</p>
|
||
<p>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.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_new_feed_url</strong> – New feed URL.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">New feed URL.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_owner">
|
||
<code class="descname">itunes_owner</code><span class="sig-paren">(</span><em>name=None</em>, <em>email=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_owner" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_owner</strong> – The owner of the feed.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data of the owner of the feed.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_subtitle">
|
||
<code class="descname">itunes_subtitle</code><span class="sig-paren">(</span><em>itunes_subtitle=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_subtitle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_subtitle</strong> – Subtitle of the podcast.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Subtitle of the podcast.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_summary">
|
||
<code class="descname">itunes_summary</code><span class="sig-paren">(</span><em>itunes_summary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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
|
||
<cite><itunes:summary></cite> is not included, the contents of the <description>
|
||
tag are used.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_summary</strong> – Summary of the podcast.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Summary of the podcast.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||
|
||
<p>
|
||
«  <a href="api.ext.dc.html">feedgen.ext.dc</a>
|
||
  ::  
|
||
<a class="uplink" href="../index.html">Contents</a>
|
||
  ::  
|
||
<a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>  »
|
||
</p>
|
||
|
||
</div>
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2013-2016, Lars Kiesow.
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||
</div>
|
||
</body>
|
||
</html> |