twisterp2pblockchainnetworkbittorrentmicrobloggingipv6social-networkdhtdecentralizedtwisterarmyp2p-networktwister-servertwister-ipv6twister-core
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
188 lines
8.4 KiB
188 lines
8.4 KiB
<?xml version="1.0" encoding="utf-8" ?> |
|
<!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" xml:lang="en" lang="en"> |
|
<head> |
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
<meta name="generator" content="Docutils 0.10: http://docutils.sourceforge.net/" /> |
|
<title>libtorrent python binding</title> |
|
<meta name="author" content="Arvid Norberg, arvid@rasterbar.com" /> |
|
<link rel="stylesheet" type="text/css" href="../../css/base.css" /> |
|
<link rel="stylesheet" type="text/css" href="../../css/rst.css" /> |
|
<script type="text/javascript"> |
|
/* <![CDATA[ */ |
|
(function() { |
|
var s = document.createElement('script'), t = document.getElementsByTagName('script')[0]; |
|
s.type = 'text/javascript'; |
|
s.async = true; |
|
s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto'; |
|
t.parentNode.insertBefore(s, t); |
|
})(); |
|
/* ]]> */ |
|
</script> |
|
<link rel="stylesheet" href="style.css" type="text/css" /> |
|
<style type="text/css"> |
|
/* Hides from IE-mac \*/ |
|
* html pre { height: 1%; } |
|
/* End hide from IE-mac */ |
|
</style> |
|
</head> |
|
<body> |
|
<div class="document" id="libtorrent-python-binding"> |
|
<div id="container"> |
|
<div id="headerNav"> |
|
<ul> |
|
<li class="first"><a href="/">Home</a></li> |
|
<li><a href="../../products.html">Products</a></li> |
|
<li><a href="../../contact.html">Contact</a></li> |
|
</ul> |
|
</div> |
|
<div id="header"> |
|
<h1><span>Rasterbar Software</span></h1> |
|
<h2><span>Software developement and consulting</span></h2> |
|
</div> |
|
<div id="main"> |
|
<h1 class="title">libtorrent python binding</h1> |
|
<table class="docinfo" frame="void" rules="none"> |
|
<col class="docinfo-name" /> |
|
<col class="docinfo-content" /> |
|
<tbody valign="top"> |
|
<tr><th class="docinfo-name">Author:</th> |
|
<td>Arvid Norberg, <a class="last reference external" href="mailto:arvid@rasterbar.com">arvid@rasterbar.com</a></td></tr> |
|
</tbody> |
|
</table> |
|
<div class="contents topic" id="table-of-contents"> |
|
<p class="topic-title first">Table of contents</p> |
|
<ul class="simple"> |
|
<li><a class="reference internal" href="#building" id="id2">building</a><ul> |
|
<li><a class="reference internal" href="#building-using-setup-py" id="id3">building using setup.py</a></li> |
|
<li><a class="reference internal" href="#building-using-boost-build" id="id4">building using boost build</a></li> |
|
</ul> |
|
</li> |
|
<li><a class="reference internal" href="#using-libtorrent-in-python" id="id5">using libtorrent in python</a></li> |
|
</ul> |
|
</div> |
|
<div class="section" id="building"> |
|
<h1>building</h1> |
|
<p>Building the libtorrent python bindings will produce a shared library (DLL) |
|
which is a python module that can be imported in a python program.</p> |
|
<div class="section" id="building-using-setup-py"> |
|
<h2>building using setup.py</h2> |
|
<p>There is a <tt class="docutils literal">setup.py</tt> shipped with libtorrent that can be used on windows. |
|
On windows the setup.py will invoke <tt class="docutils literal">bjam</tt> and assume that you have boost |
|
sources at <tt class="docutils literal">$BOOST_PATH</tt>. The resulting executable is self-contained, it does |
|
not depend any boost or libtorrent dlls.</p> |
|
<p>On other systems, the setup.py is generated by running |
|
<tt class="docutils literal">./configure <span class="pre">--enable-python-binding</span></tt>.</p> |
|
<p>To build the Python bindings do:</p> |
|
<ol class="arabic"> |
|
<li><p class="first">Run:</p> |
|
<pre class="literal-block"> |
|
python setup.py build |
|
</pre> |
|
</li> |
|
<li><p class="first">As root, run:</p> |
|
<pre class="literal-block"> |
|
python setup.py install |
|
</pre> |
|
</li> |
|
</ol> |
|
</div> |
|
<div class="section" id="building-using-boost-build"> |
|
<h2>building using boost build</h2> |
|
<p>To set up your build environment, you need to add some settings to your |
|
<tt class="docutils literal"><span class="pre">$BOOST_BUILD_PATH/user-config.jam</span></tt>.</p> |
|
<p>Make sure your user config contains the following line:</p> |
|
<pre class="literal-block"> |
|
using python : 2.3 ; |
|
</pre> |
|
<p>Set the version to the version of python you have installed or want to use. If |
|
you've installed python in a non-standard location, you have to add the prefix |
|
path used when you installed python as a second option. Like this:</p> |
|
<pre class="literal-block"> |
|
using python : 2.6 : /usr/bin/python2.6 : /usr/include/python2.6 : /usr/lib/python2.6 ; |
|
</pre> |
|
<p>The bindings require <em>at least</em> python version 2.2.</p> |
|
<p>For more information on how to install and set up boost-build, see the |
|
<a class="reference external" href="building.html#step-2-setup-bbv2">building libtorrent</a> section.</p> |
|
<p>Once you have boost-build set up, you cd to the <tt class="docutils literal">bindings/python</tt> |
|
directory and invoke <tt class="docutils literal">bjam</tt> with the apropriate settings. For the available |
|
build variants, see <a class="reference external" href="building.html#step-3-building-libtorrent">libtorrent build options</a>.</p> |
|
<p>For example:</p> |
|
<pre class="literal-block"> |
|
$ bjam dht-support=on boost=source release link=static |
|
</pre> |
|
<p>On Mac OS X, this will produce the following python module:</p> |
|
<pre class="literal-block"> |
|
bin/darwin-4.0/release/dht-support-on/link-static/logging-none/threading-multi/libtorrent.so |
|
</pre> |
|
</div> |
|
</div> |
|
<div class="section" id="using-libtorrent-in-python"> |
|
<h1>using libtorrent in python</h1> |
|
<p>The python interface is nearly identical to the C++ interface. Please refer to |
|
the <a class="reference external" href="manual.html">main library reference</a>. The main differences are:</p> |
|
<dl class="docutils"> |
|
<dt>asio::tcp::endpoint</dt> |
|
<dd>The endpoint type is represented as a tuple of a string (as the address) and an int for |
|
the port number. E.g. <tt class="docutils literal">('127.0.0.1', 6881)</tt> represents the localhost port 6881.</dd> |
|
<dt>libtorrent::time_duration</dt> |
|
<dd>The time duration is represented as a number of seconds in a regular integer.</dd> |
|
</dl> |
|
<p>The following functions takes a reference to a container that is filled with |
|
entries by the function. The python equivalent of these functions instead returns |
|
a list of entries.</p> |
|
<ul class="simple"> |
|
<li>torrent_handle::get_peer_info</li> |
|
<li>torrent_handle::file_progress</li> |
|
<li>torrent_handle::get_download_queue</li> |
|
<li>torrent_handle::piece_availability</li> |
|
</ul> |
|
<p><tt class="docutils literal"><span class="pre">create_torrent::add_node()</span></tt> takes two arguments, one string and one integer, |
|
instead of a pair. The string is the address and the integer is the port.</p> |
|
<p><tt class="docutils literal"><span class="pre">session::set_settings()</span></tt> not only accepts a <tt class="docutils literal">session_settings</tt> object, but also |
|
a dictionary with keys matching the names of the members of the <tt class="docutils literal">session_settings</tt> struct. |
|
When calling <tt class="docutils literal">set_settings</tt>, the dictionary does not need to have every settings set, |
|
keys that are not present, are set to their default value.</p> |
|
<p>For backwards compatibility, <tt class="docutils literal"><span class="pre">session::settings()</span></tt> still returns a <tt class="docutils literal">session_settings</tt> |
|
struct. To get a python dictionary of the settings, call <tt class="docutils literal"><span class="pre">session::get_settings</span></tt>.</p> |
|
<p>For an example python program, see <tt class="docutils literal">client.py</tt> in the <tt class="docutils literal">bindings/python</tt> |
|
directory.</p> |
|
<p>A very simple example usage of the module would be something like this:</p> |
|
<pre class="literal-block"> |
|
import libtorrent as lt |
|
import time |
|
|
|
ses = lt.session() |
|
ses.listen_on(6881, 6891) |
|
|
|
e = lt.bdecode(open("test.torrent", 'rb').read()) |
|
info = lt.torrent_info(e) |
|
|
|
h = ses.add_torrent(info, "./", storage_mode=storage_mode_sparse) |
|
|
|
while (not h.is_seed()): |
|
s = h.status() |
|
|
|
state_str = ['queued', 'checking', 'downloading metadata', \ |
|
'downloading', 'finished', 'seeding', 'allocating'] |
|
print '%.2f%% complete (down: %.1f kb/s up: %.1f kB/s peers: %d) %s' % \ |
|
(s.progress * 100, s.download_rate / 1000, s.upload_rate / 1000, \ |
|
s.num_peers, state_str[s.state]) |
|
|
|
time.sleep(1) |
|
</pre> |
|
</div> |
|
</div> |
|
<div id="footer"> |
|
<span>Copyright © 2005 Rasterbar Software.</span> |
|
</div> |
|
</div> |
|
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"> |
|
</script> |
|
<script type="text/javascript"> |
|
_uacct = "UA-1599045-1"; |
|
urchinTracker(); |
|
</script> |
|
</div> |
|
</body> |
|
</html>
|
|
|