<!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="Content-Type" content="text/html; charset=utf-8" />
<title>Tutorial — python_webdav v0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.5',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="python_webdav v0.5 documentation" href="index.html" />
<link rel="next" title="API" href="api.html" />
<link rel="prev" title="Client" href="Client.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="api.html" title="API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Client.html" title="Client"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python_webdav v0.5 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="tutorial">
<h1>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>The idea behind the python-webdav library is to provide developers with an easy to use library that can also allow for a finer grain of control when needed.</p>
<p>The library currently contains two main modules: connection and client</p>
<div class="section" id="connection-module">
<h3>Connection Module<a class="headerlink" href="#connection-module" title="Permalink to this headline">¶</a></h3>
<p>The connection module itself has three classes: Connection, Client and LockToken.</p>
<div class="section" id="connection">
<h4>Connection<a class="headerlink" href="#connection" title="Permalink to this headline">¶</a></h4>
<p>The Connection class is for setting up a connection object and using it to send HTTP requests to a WebDAV server.</p>
<p>It is a low level class that is meant for direct communication with the server.</p>
</div>
<div class="section" id="client">
<h4>Client<a class="headerlink" href="#client" title="Permalink to this headline">¶</a></h4>
<p>The Client class contains methods for getting and parsing WebDAV responses. It mainly ustilises the Connection class but is a bit more user friendly.</p>
<p>It uses the parse module to create Resource objects that contain the information about each WebDAV resource.</p>
</div>
<div class="section" id="locktoken">
<h4>LockToken<a class="headerlink" href="#locktoken" title="Permalink to this headline">¶</a></h4>
<p>Lock tokens are used to aid in basic access control for files contained on a WebDAV server. This is a simple class for containing a lock token as an object.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Currently locks are not implemented.</p>
</div>
</div>
</div>
<div class="section" id="first-basic-examples">
<h3>First basic examples<a class="headerlink" href="#first-basic-examples" title="Permalink to this headline">¶</a></h3>
<p>To import the library, use:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">python_webdav</span>
</pre></div>
</div>
<p>Using the basic functionality of the library is simple. Start by making a Client object:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">python_webdav.client</span> <span class="kn">as</span> <span class="nn">pywebdav_client</span>
<span class="n">client_object</span> <span class="o">=</span> <span class="n">pywebdav_client</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="s">'https://webdav.example.net/'</span><span class="p">)</span>
<span class="n">client_object</span><span class="o">.</span><span class="n">set_connection</span><span class="p">(</span><span class="n">username</span><span class="o">=</span><span class="s">'KingArthur'</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="s">'HolyGrail'</span><span class="p">)</span>
</pre></div>
</div>
<p>This will set up a Client object that will communicate with the given server and credentials.</p>
<p>The idea of setting up the server and authentication information seperately, is to allow the connection to be used for different users, instead of havingto create individual connections for each user.</p>
<p>To download a file:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">python_webdav</span>
<span class="n">client_object</span> <span class="o">=</span> <span class="n">python_webdav</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="s">'https://webdav.example.net/'</span><span class="p">)</span>
<span class="n">client_object</span><span class="o">.</span><span class="n">set_connection</span><span class="p">(</span><span class="n">username</span><span class="o">=</span><span class="s">'KingArthur'</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="s">'HolyGrail'</span><span class="p">)</span>
<span class="n">client_object</span><span class="o">.</span><span class="n">download_file</span><span class="p">(</span><span class="s">'some_file.txt'</span><span class="p">,</span> <span class="n">dest_path</span><span class="o">=</span><span class="s">'.'</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="">Tutorial</a><ul>
<li><a class="reference external" href="#introduction">Introduction</a><ul>
<li><a class="reference external" href="#connection-module">Connection Module</a><ul>
<li><a class="reference external" href="#connection">Connection</a></li>
<li><a class="reference external" href="#client">Client</a></li>
<li><a class="reference external" href="#locktoken">LockToken</a></li>
</ul>
</li>
<li><a class="reference external" href="#first-basic-examples">First basic examples</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="Client.html"
title="previous chapter">Client</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="api.html"
title="next chapter">API</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/Tutorial.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="api.html" title="API"
>next</a> |</li>
<li class="right" >
<a href="Client.html" title="Client"
>previous</a> |</li>
<li><a href="index.html">python_webdav v0.5 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Becky Lewis.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
</div>
</body>
</html>
