python-feedgen/ext/api.ext.torrent.html

198 lines
9.9 KiB
HTML
Raw Normal View History

2018-05-19 22:07:44 +02:00
2016-09-04 21:54:21 +02:00
<!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>
2018-06-03 10:41:51 +02:00
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
2016-09-04 21:54:21 +02:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2018-05-19 22:07:44 +02:00
<title>feedgen.ext.torrent &#8212; python-feedgen 0.7.0 documentation</title>
2016-09-04 21:54:21 +02:00
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
2018-06-03 10:41:51 +02:00
<script type="text/javascript" src="../_static/documentation_options.js"></script>
2016-09-04 21:54:21 +02:00
<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>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
2016-09-04 21:54:21 +02:00
<link rel="prev" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
2018-06-03 10:41:51 +02:00
</head><body>
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
2018-05-19 22:07:44 +02:00
<span>python-feedgen 0.7.0 documentation</span></a></h1>
2016-09-04 21:54:21 +02:00
<h2 class="heading"><span>feedgen.ext.torrent</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
2016-09-04 21:54:21 +02:00
<p>
«&#160;&#160;<a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</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.torrent"></span><div class="section" id="feedgen-ext-torrent">
<h1>feedgen.ext.torrent<a class="headerlink" href="#feedgen-ext-torrent" title="Permalink to this headline"></a></h1>
<p>Extends the FeedGenerator to produce torrent feeds.</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">2016, Raspbeguy &lt;<a class="reference external" href="mailto:raspbeguy&#37;&#52;&#48;hashtagueule&#46;fr">raspbeguy<span>&#64;</span>hashtagueule<span>&#46;</span>fr</a>&gt;</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.torrent.TorrentEntryExtension">
<em class="property">class </em><code class="descclassname">feedgen.ext.torrent.</code><code class="descname">TorrentEntryExtension</code><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension" title="Permalink to this definition"></a></dt>
2018-05-19 22:07:44 +02:00
<dd><p>FeedEntry extension for torrent feeds</p>
2016-09-04 21:54:21 +02:00
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentEntryExtension.contentlength">
<code class="descname">contentlength</code><span class="sig-paren">(</span><em>torrent_contentlength=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.contentlength" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>Get or set the size of the target file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
2018-05-19 22:07:44 +02:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_contentlength</strong> The target file size.</td>
2016-09-04 21:54:21 +02:00
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The target file size.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentEntryExtension.extend_rss">
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>entry</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.extend_rss" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>Add additional fields to an RSS item.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
2018-05-19 22:07:44 +02:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feed</strong> The RSS item XML element to use.</td>
2016-09-04 21:54:21 +02:00
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentEntryExtension.filename">
<code class="descname">filename</code><span class="sig-paren">(</span><em>torrent_filename=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.filename" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>Get or set the name of the torrent file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
2018-05-19 22:07:44 +02:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_filename</strong> The name of the torrent file.</td>
2016-09-04 21:54:21 +02:00
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The name of the torrent file.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentEntryExtension.infohash">
<code class="descname">infohash</code><span class="sig-paren">(</span><em>torrent_infohash=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.infohash" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>Get or set the hash of the target file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
2018-05-19 22:07:44 +02:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_infohash</strong> The target file hash.</td>
2016-09-04 21:54:21 +02:00
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The target hash file.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentEntryExtension.peers">
<code class="descname">peers</code><span class="sig-paren">(</span><em>torrent_peers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.peers" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>Get or set the number od peers</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
2018-05-19 22:07:44 +02:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_infohash</strong> The peers number.</td>
2016-09-04 21:54:21 +02:00
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The peers number.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentEntryExtension.seeds">
<code class="descname">seeds</code><span class="sig-paren">(</span><em>torrent_seeds=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.seeds" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>Get or set the number of seeds.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
2018-05-19 22:07:44 +02:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_seeds</strong> The seeds number.</td>
2016-09-04 21:54:21 +02:00
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The seeds number.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentEntryExtension.verified">
<code class="descname">verified</code><span class="sig-paren">(</span><em>torrent_verified=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.verified" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>Get or set the number of verified peers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
2018-05-19 22:07:44 +02:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_infohash</strong> The verified peers number.</td>
2016-09-04 21:54:21 +02:00
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The verified peers number.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="feedgen.ext.torrent.TorrentExtension">
<em class="property">class </em><code class="descclassname">feedgen.ext.torrent.</code><code class="descname">TorrentExtension</code><a class="headerlink" href="#feedgen.ext.torrent.TorrentExtension" title="Permalink to this definition"></a></dt>
2016-09-04 21:54:21 +02:00
<dd><p>FeedGenerator extension for torrent feeds.</p>
2018-06-03 10:41:51 +02:00
<dl class="method">
<dt id="feedgen.ext.torrent.TorrentExtension.extend_ns">
<code class="descname">extend_ns</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentExtension.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>
2016-09-04 21:54:21 +02:00
</dd></dl>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
2016-09-04 21:54:21 +02:00
<p>
«&#160;&#160;<a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
</p>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2013-2016, Lars Kiesow.
2018-06-03 10:41:51 +02:00
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
2016-09-04 21:54:21 +02:00
</div>
</body>
</html>