<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.entry.FeedEntry">
<emclass="property">class </em><ttclass="descclassname">feedgen.entry.</tt><ttclass="descname">FeedEntry</tt><aclass="headerlink"href="#feedgen.entry.FeedEntry"title="Permalink to this definition">¶</a></dt>
<dd><p>FeedEntry call representing an ATOM feeds entry node or an RSS feeds item
node.</p>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.atom_entry">
<ttclass="descname">atom_entry</tt><big>(</big><em>feed</em>, <em>extensions=True</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.atom_entry"title="Permalink to this definition">¶</a></dt>
<dd><p>Insert an ATOM entry into a existing XML structure. Normally you
would pass the feed node of an ATOM feed XML to this function.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>feed</strong>– The XML element to use as parent node for the element.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.author">
<ttclass="descname">author</tt><big>(</big><em>author=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.author"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set autor data. An author element is a dict containing a name,
an email adress and a uri. Name is mandatory for ATOM, email is mandatory
for RSS.</p>
<p>This method can be called with:
- the fields of an author as keyword arguments
- the fields of an author as a dictionary
- a list of dictionaries containing the author fields</p>
<p>An author 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>
<ttclass="descname">category</tt><big>(</big><em>category=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.category"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set categories that the entry belongs to.</p>
<p>This method can be called with:
- the fields of a category as keyword arguments
- the fields of a category as a dictionary
- a list of dictionaries containing the category fields</p>
<p>A categories has the following fields:
- <em>term</em> identifies the category
- <em>scheme</em> identifies the categorization scheme via a URI.
- <em>label</em> provides a human-readable label for display</p>
<p>If a label is present it is used for the RSS feeds. Otherwise the term is
used. The scheme is used for the domain attribute in RSS.</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.entry.FeedEntry.comments">
<ttclass="descname">comments</tt><big>(</big><em>comments=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.comments"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the the value of comments which is the url of the comments
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>comments</strong>– URL to the comments page.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">URL to the comments page.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.content">
<ttclass="descname">content</tt><big>(</big><em>content=None</em>, <em>src=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.content"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the cntent of the entry which contains or links to the
complete content of the entry. Content must be provided for ATOM entries
if there is no alternate link, and should be provided if there is no
summary. If the content is set (not linked) it will also set
<li><strong>content</strong>– The content of the feed entry.</li>
<li><strong>src</strong>– Link to the entries content.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">Content element of the entry.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.contributor">
<ttclass="descname">contributor</tt><big>(</big><em>contributor=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.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.entry.FeedEntry.description">
<ttclass="descname">description</tt><big>(</big><em>description=None</em>, <em>isSummary=False</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.description"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the description value which is the item synopsis.
Description is an RSS only element. For ATOM feeds it is split in summary
and content. The isSummary parameter can be used to control which ATOM
<ttclass="descname">enclosure</tt><big>(</big><em>url=None</em>, <em>length=None</em>, <em>type=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.enclosure"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the value of enclosure which describes a media object that
is attached to the item. This is a RSS only value which is represented by
link(rel=enclosure) in ATOM. ATOM feeds can furthermore contain several
enclosures while RSS may contain only one. That is why this method, if
repeatedly called, will add more than one enclosures to the feed.
<li><strong>url</strong>– URL of the media object.</li>
<li><strong>length</strong>– Size of the media in bytes.</li>
<li><strong>type</strong>– Mimetype of the linked media.</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">Data of the enclosure element.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.guid">
<ttclass="descname">guid</tt><big>(</big><em>guid=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.guid"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the entries guid which is a string that uniquely identifies
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>guid</strong>– Id of the entry.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Id of the entry.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.id">
<ttclass="descname">id</tt><big>(</big><em>id=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.id"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the entry id which identifies the entry using a universally
unique and permanent URI. Two entries in a feed can have the same value
for id if they represent the same entry at different points in time. This
method will also set rss:guid. Id is mandatory for an ATOM entry.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>id</strong>– New Id of the entry.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Id of the entry.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.link">
<ttclass="descname">link</tt><big>(</big><em>link=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.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>
</li>
</ul>
<p>RSS only supports one link with nothing but a URL. So for the RSS link
element the last link with rel=alternate is used.</p>
<p>RSS also supports one enclusure element per entry which is covered by the
link element in ATOM feed entries. So for the RSS enclusure element the
<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 link data.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.load_extension">
<ttclass="descname">load_extension</tt><big>(</big><em>name</em>, <em>atom=True</em>, <em>rss=True</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.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.entry.FeedEntry.pubdate">
<ttclass="descname">pubdate</tt><big>(</big><em>pubDate=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.pubdate"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the pubDate of the entry which indicates when the entry was
published. This method is just another name for the published(...)
method.</p>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.published">
<ttclass="descname">published</tt><big>(</big><em>published=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.published"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>published</strong>– The creation date.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Creation date as datetime.datetime</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.rights">
<ttclass="descname">rights</tt><big>(</big><em>rights=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.rights"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the rights value of the entry which conveys information
about rights, e.g. copyrights, held in and over the entry. This ATOM value
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>rights</strong>– Rights information of the feed.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Rights information of the feed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.rss_entry">
<ttclass="descname">rss_entry</tt><big>(</big><em>feed</em>, <em>extensions=True</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.rss_entry"title="Permalink to this definition">¶</a></dt>
<dd><p>Insert an RSS item into a existing XML structure. Normally you
would pass the channel node of an RSS feed XML to this function.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>feed</strong>– The XML element to use as parent node for the item.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.summary">
<ttclass="descname">summary</tt><big>(</big><em>summary=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.summary"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the summary element of an entry which conveys a short
summary, abstract, or excerpt of the entry. Summary is an ATOM only
element and should be provided if there either is no content provided for
the entry, or that content is not inline (i.e., contains a src
attribute), or if the content is encoded in base64.
This method will also set the rss:description field if it wasn’t
previously set or contains the old value of summary.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>summary</strong>– Summary of the entries contents.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Summary of the entries contents.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.title">
<ttclass="descname">title</tt><big>(</big><em>title=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.title"title="Permalink to this definition">¶</a></dt>
<dd><p>Get or set the title value of the entry. It should contain a human
readable title for the entry. Title is mandatory for both ATOM and RSS
<ttclass="descname">ttl</tt><big>(</big><em>ttl=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.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 representing the time to live.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Time to live of of the entry.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="feedgen.entry.FeedEntry.updated">
<ttclass="descname">updated</tt><big>(</big><em>updated=None</em><big>)</big><aclass="headerlink"href="#feedgen.entry.FeedEntry.updated"title="Permalink to this definition">¶</a></dt>
<dd><p>Set or get the updated value which indicates the last time the entry
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
