<trclass="field-odd field"><thclass="field-name">copyright:</th><tdclass="field-body">2013, Lars Kiesow <<aclass="reference external"href="mailto:lkiesow%40uos.de">lkiesow<span>@</span>uos<span>.</span>de</a>></td>
</tr>
<trclass="field-even field"><thclass="field-name">license:</th><tdclass="field-body">FreeBSD and LGPL, see license.* for more details.</td>
</tr>
</tbody>
</table>
<dlclass="class">
<dtid="feedgen.feed.FeedGenerator">
<emclass="property">class </em><ttclass="descclassname">feedgen.feed.</tt><ttclass="descname">FeedGenerator</tt><aclass="headerlink"href="#feedgen.feed.FeedGenerator"title="Permalink to this definition">¶</a></dt>
<dd><p>FeedGenerator for generating ATOM and RSS feeds.</p>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.add_entry">
<ttclass="descname">add_entry</tt><big>(</big><em>feedEntry=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.add_entry"title="Permalink to this definition">¶</a></dt>
<dd><p>This method will add a new entry to the feed. If the feedEntry
argument is omittet a new Entry object is created automatically. This is
the prefered way to add new entries to a feed.</p>
<ttclass="descname">add_item</tt><big>(</big><em>item=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.add_item"title="Permalink to this definition">¶</a></dt>
<dd><p>This method will add a new item to the feed. If the item argument is
omittet a new FeedEntry object is created automatically. This is just
<ttclass="descname">atom_file</tt><big>(</big><em>filename</em>, <em>extensions=True</em>, <em>pretty=False</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.atom_file"title="Permalink to this definition">¶</a></dt>
<li><strong>extensions</strong>– Enable or disable the loaded extensions for the xml
generation (default: enabled).</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.atom_str">
<ttclass="descname">atom_str</tt><big>(</big><em>pretty=False</em>, <em>extensions=True</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.atom_str"title="Permalink to this definition">¶</a></dt>
<dd><p>Generates an ATOM feed and returns the feed XML as string.</p>
<li><strong>pretty</strong>– If the feed should be split into multiple lines and
properly indented.</li>
<li><strong>extensions</strong>– Enable or disable the loaded extensions for the xml
generation (default: enabled).</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">String representation of the ATOM feed.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.author">
<ttclass="descname">author</tt><big>(</big><em>author=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.author"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set author data. An author element is a dictionary containing a name,
an email address and a URI. Name is mandatory for ATOM, email is mandatory
<ttclass="descname">category</tt><big>(</big><em>category=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.category"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set categories that the feed belongs to.</p>
<li><strong>link</strong>– Dict or list of dicts with data.</li>
<li><strong>replace</strong>– Add or replace old data.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">List of category data.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.cloud">
<ttclass="descname">cloud</tt><big>(</big><em>domain=None</em>, <em>port=None</em>, <em>path=None</em>, <em>registerProcedure=None</em>, <em>protocol=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.cloud"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the cloud data of the feed. It is an RSS only attribute. It
specifies a web service that supports the rssCloud interface which can be
implemented in HTTP-POST, XML-RPC or SOAP 1.1.</p>
<li><strong>domain</strong>– The domain where the webservice can be found.</li>
<li><strong>port</strong>– The port the webservice listens to.</li>
<li><strong>path</strong>– The path of the webservice.</li>
<li><strong>registerProcedure</strong>– The procedure to call.</li>
<li><strong>protocol</strong>– Can be either HTTP-POST, XML-RPC or SOAP 1.1.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">Dictionary containing the cloud data.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.contributor">
<ttclass="descname">contributor</tt><big>(</big><em>contributor=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.contributor"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the contributor data of the feed. This is an ATOM only
value.</p>
<p>This method can be called with:
- the fields of an contributor as keyword arguments
- the fields of an contributor as a dictionary
- a list of dictionaries containing the contributor fields</p>
<p>An contributor has the following fields:
- <em>name</em> conveys a human-readable name for the person.
- <em>uri</em> contains a home page for the person.
- <em>email</em> contains an email address for the person.</p>
<li><strong>contributor</strong>– Dictionary or list of dictionaries with contributor data.</li>
<li><strong>replace</strong>– Add or replace old data.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">List of contributors as dictionaries.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.copyright">
<ttclass="descname">copyright</tt><big>(</big><em>copyright=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.copyright"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the copyright notice for content in the channel. This RSS
<ttclass="descname">description</tt><big>(</big><em>description=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.description"title="Permalink to this definition">¶</a></dt>
<dd><p>Set and get the description of the feed. This is an RSS only element
which is a phrase or sentence describing the channel. It is mandatory for
RSS feeds. It is roughly the same as atom:subtitle. Thus setting this
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>description</strong>– Description of the channel.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Description of the channel.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.docs">
<ttclass="descname">docs</tt><big>(</big><em>docs=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.docs"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the docs value of the feed. This is an RSS only value. It
is a URL that points to the documentation for the format used in the RSS
file. It is probably a pointer to [1]. It is for people who might stumble
across an RSS file on a Web server 25 years from now and wonder what it
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>docs</strong>– URL of the format documentation.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">URL of the format documentation.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.entry">
<ttclass="descname">entry</tt><big>(</big><em>entry=None</em>, <em>replace=False</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.entry"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set feed entries. Use the add_entry() method instead to
automatically create the FeedEntry objects.</p>
<p>This method takes both a single FeedEntry object or a list of objects.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>entry</strong>– FeedEntry object or list of FeedEntry objects.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">List ob all feed entries.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.generator">
<ttclass="descname">generator</tt><big>(</big><em>generator=None</em>, <em>version=None</em>, <em>uri=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.generator"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or the generator of the feed which identifies the software used to
generate the feed, for debugging and other purposes. Both the uri and
version attributes are optional and only available in the ATOM feed.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>generator</strong>– Software used to create the feed.</li>
<li><strong>version</strong>– Version of the software.</li>
<li><strong>uri</strong>– URI the software can be found.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.icon">
<ttclass="descname">icon</tt><big>(</big><em>icon=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.icon"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the icon of the feed which is a small image which provides
iconic visual identification for the feed. Icons should be square. This
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>icon</strong>– URI of the feeds icon.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">URI of the feeds icon.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.id">
<ttclass="descname">id</tt><big>(</big><em>id=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.id"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the feed id which identifies the feed using a universally
unique and permanent URI. If you have a long-term, renewable lease on
your Internet domain name, then you can feel free to use your website’s
address. This field is for ATOM only. It is mandatory for ATOM.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>id</strong>– New Id of the ATOM feed.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Id of the feed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.image">
<ttclass="descname">image</tt><big>(</big><em>url=None</em>, <em>title=None</em>, <em>link=None</em>, <em>width=None</em>, <em>height=None</em>, <em>description=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.image"title="Permalink to this definition">¶</a></dt>
<dd><p>Set the image of the feed. This element is roughly equivalent to
<li><strong>url</strong>– The URL of a GIF, JPEG or PNG image.</li>
<li><strong>title</strong>– Describes the image. The default value is the feeds title.</li>
<li><strong>link</strong>– URL of the site the image will link to. The default is to
use the feeds first altertate link.</li>
<li><strong>width</strong>– Width of the image in pixel. The maximum is 144.</li>
<li><strong>height</strong>– The height of the image. The maximum is 400.</li>
<li><strong>description</strong>– Title of the link.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">Data of the image as dictionary.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.item">
<ttclass="descname">item</tt><big>(</big><em>item=None</em>, <em>replace=False</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.item"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set feed items. This is just another name for entry(...)</p>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.language">
<ttclass="descname">language</tt><big>(</big><em>language=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.language"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the language of the feed. It indicates the language the
channel is written in. This allows aggregators to group all Italian
language sites, for example, on a single page. This is an RSS only field.
However, this value will also be used to set the xml:lang property of the
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>language</strong>– Language of the feed.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Language of the feed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.lastBuildDate">
<ttclass="descname">lastBuildDate</tt><big>(</big><em>lastBuildDate=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.lastBuildDate"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the lastBuildDate value which indicates the last time the
content of the channel changed.</p>
<p>The value can either be a string which will automatically be parsed or a
datetime.datetime object. In any case it is necessary that the value
include timezone information.</p>
<p>This will set both atom:updated and rss:lastBuildDate.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>lastBuildDate</strong>– The modification date.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Modification date as datetime.datetime</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.link">
<ttclass="descname">link</tt><big>(</big><em>link=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.link"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set link data. An link element is a dict with the fields href,
rel, type, hreflang, title, and length. Href is mandatory for ATOM.</p>
<p>This method can be called with:
- the fields of a link as keyword arguments
- the fields of a link as a dictionary
- a list of dictionaries containing the link fields</p>
<p>A link has the following fields:</p>
<ul>
<li><pclass="first"><em>href</em> is the URI of the referenced resource (typically a Web page)</p>
</li>
<li><pclass="first"><em>rel</em> contains a single link relationship type. It can be a full URI,
or one of the following predefined values (default=alternate):</p>
<blockquote>
<div><ulclass="simple">
<li><em>alternate</em> an alternate representation of the entry or feed, for
example a permalink to the html version of the entry, or the front
page of the weblog.</li>
<li><em>enclosure</em> a related resource which is potentially large in size
and might require special handling, for example an audio or video
recording.</li>
<li><em>related</em> an document related to the entry or feed.</li>
<li><em>self</em> the feed itself.</li>
<li><em>via</em> the source of the information provided in the entry.</li>
</ul>
</div></blockquote>
</li>
<li><pclass="first"><em>type</em> indicates the media type of the resource.</p>
</li>
<li><pclass="first"><em>hreflang</em> indicates the language of the referenced resource.</p>
</li>
<li><pclass="first"><em>title</em> human readable information about the link, typically for
display purposes.</p>
</li>
<li><pclass="first"><em>length</em> the length of the resource, in bytes.</p>
<ttclass="descname">load_extension</tt><big>(</big><em>name</em>, <em>atom=True</em>, <em>rss=True</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.load_extension"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong>– Name of the extension to load.</li>
<li><strong>atom</strong>– If the extension should be used for ATOM feeds.</li>
<li><strong>rss</strong>– If the extension should be used for RSS feeds.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.logo">
<ttclass="descname">logo</tt><big>(</big><em>logo=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.logo"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the logo of the feed which is a larger image which provides
visual identification for the feed. Images should be twice as wide as
they are tall. This is an ATOM value but will also set the rss:image
<ttclass="descname">managingEditor</tt><big>(</big><em>managingEditor=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.managingEditor"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the value for managingEditor which is the email address for
person responsible for editorial content. This is a RSS only value.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>managingEditor</strong>– Email adress of the managing editor.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Email adress of the managing editor.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.pubDate">
<ttclass="descname">pubDate</tt><big>(</big><em>pubDate=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.pubDate"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the publication date for the content in the channel. For
example, the New York Times publishes on a daily basis, the publication
date flips once every 24 hours. That’s when the pubDate of the channel
changes.</p>
<p>The value can either be a string which will automatically be parsed or a
datetime.datetime object. In any case it is necessary that the value
include timezone information.</p>
<p>This will set both atom:updated and rss:lastBuildDate.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>pubDate</strong>– The publication date.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Publication date as datetime.datetime</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.rating">
<ttclass="descname">rating</tt><big>(</big><em>rating=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.rating"title="Permalink to this definition">¶</a></dt>
<dd><p>Set and get the PICS rating for the channel. It is an RSS only
value.</p>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.remove_entry">
<ttclass="descname">remove_entry</tt><big>(</big><em>entry</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.remove_entry"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a single entry from the feed. This method accepts both the
FeedEntry object to remove or the index of the entry as argument.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>entry</strong>– Entry or index of entry to remove.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.remove_item">
<ttclass="descname">remove_item</tt><big>(</big><em>item</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.remove_item"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a single item from the feed. This is another name for
remove_entry.</p>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.rights">
<ttclass="descname">rights</tt><big>(</big><em>rights=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.rights"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the rights value of the feed which conveys information
about rights, e.g. copyrights, held in and over the feed. This ATOM value
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>rights</strong>– Rights information of the feed.</td>
<ttclass="descname">rss_file</tt><big>(</big><em>filename</em>, <em>extensions=True</em>, <em>pretty=False</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.rss_file"title="Permalink to this definition">¶</a></dt>
<li><strong>extensions</strong>– Enable or disable the loaded extensions for the xml
generation (default: enabled).</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.rss_str">
<ttclass="descname">rss_str</tt><big>(</big><em>pretty=False</em>, <em>extensions=True</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.rss_str"title="Permalink to this definition">¶</a></dt>
<dd><p>Generates an RSS feed and returns the feed XML as string.</p>
<li><strong>pretty</strong>– If the feed should be split into multiple lines and
properly indented.</li>
<li><strong>extensions</strong>– Enable or disable the loaded extensions for the xml
generation (default: enabled).</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">String representation of the RSS feed.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.skipDays">
<ttclass="descname">skipDays</tt><big>(</big><em>days=None</em>, <em>replace=False</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.skipDays"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the value of skipDays, a hint for aggregators telling them
which days they can skip This is an RSS only value.</p>
<p>This method can be called with a day name or a list of day names. The days are
represented as strings from ‘Monday’ to ‘Sunday’.</p>
<li><strong>hours</strong>– List of days the feedreaders should not check the feed.</li>
<li><strong>replace</strong>– Add or replace old data.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">List of days the feedreaders should not check the feed.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.skipHours">
<ttclass="descname">skipHours</tt><big>(</big><em>hours=None</em>, <em>replace=False</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.skipHours"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the value of skipHours, a hint for aggregators telling them
which hours they can skip. This is an RSS only value.</p>
<p>This method can be called with an hour or a list of hours. The hours are
<li><strong>hours</strong>– List of hours the feedreaders should not check the feed.</li>
<li><strong>replace</strong>– Add or replace old data.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">List of hours the feedreaders should not check the feed.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.subtitle">
<ttclass="descname">subtitle</tt><big>(</big><em>subtitle=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.subtitle"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the subtitle value of the cannel which contains a
human-readable description or subtitle for the feed. This ATOM property
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>subtitle</strong>– The subtitle of the feed.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">The subtitle of the feed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.textInput">
<ttclass="descname">textInput</tt><big>(</big><em>title=None</em>, <em>description=None</em>, <em>name=None</em>, <em>link=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.textInput"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the value of textInput. This is an RSS only field. The
purpose of the <textInput> element is something of a mystery. You can use
it to specify a search engine box. Or to allow a reader to provide
<ttclass="descname">title</tt><big>(</big><em>title=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.title"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the title value of the feed. It should contain a human
readable title for the feed. Often the same as the title of the
associated website. Title is mandatory for both ATOM and RSS and should
<ttclass="descname">ttl</tt><big>(</big><em>ttl=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.ttl"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the ttl value. It is an RSS only element. ttl stands for
time to live. It’s a number of minutes that indicates how long a channel
can be cached before refreshing from the source.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>ttl</strong>– Integer value indicating how long the channel may be cached.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Time to live.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.updated">
<ttclass="descname">updated</tt><big>(</big><em>updated=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.updated"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the updated value which indicates the last time the feed
was modified in a significant way.</p>
<p>The value can either be a string which will automatically be parsed or a
datetime.datetime object. In any case it is necessary that the value
include timezone information.</p>
<p>This will set both atom:updated and rss:lastBuildDate.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>updated</strong>– The modification date.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Modification date as datetime.datetime</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.feed.FeedGenerator.webMaster">
<ttclass="descname">webMaster</tt><big>(</big><em>webMaster=None</em><big>)</big><aclass="headerlink"href="#feedgen.feed.FeedGenerator.webMaster"title="Permalink to this definition">¶</a></dt>
<dd><p>Get and set the value of webMaster, which represents the email address
for the person responsible for technical issues relating to the feed.
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>webMaster</strong>– Email address of the webmaster.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Email address of the webmaster.</td>
