~ubuntu-branches/ubuntu/precise/ftputil/precise : contents of README.html at revision 3

~ubuntu-branches/ubuntu/precise/ftputil/precise : (revision 3)
<?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.5: http://docutils.sourceforge.net/" />
<title>ftputil</title>
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date: 2005-05-26 12:51:39 +0200 (Thu, 26 May 2005) $
:Version: $Revision: 3368 $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.
*/

/* "! important" is used here to override other ``margin-top`` and
   ``margin-bottom`` styles that are later in the stylesheet or 
   more specific.  See http://www.w3.org/TR/CSS1#the-cascade */
.first {
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em }

div.footer, div.header {
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.line-block {
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (<h#> element) */
  font-size: 80% }

table.citation {
  border-left: solid thin gray }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid thin black }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="ftputil">
<h1 class="title">ftputil</h1>

<div class="section" id="purpose">
<h1>Purpose</h1>
<p>ftputil is a high-level FTP client library for the Python programming
language. ftputil implements a virtual file system for accessing FTP
servers, that is, it can generate file-like objects for remote files.
The library supports many functions similar to those in the os,
os.path and shutil modules. ftputil has convenience functions for
conditional uploads and downloads, and handles FTP clients and servers
in different timezones.</p>
</div>
<div class="section" id="what-s-new">
<h1>What's new?</h1>
<p>Since version 2.4.1 the following changed:</p>
<ul>
<li><p class="first">Some FTP servers seem to have problems using <em>any</em> directory
argument which contains slashes. The new default for FTP commands
now is to change into the directory before actually invoking the
command on a relative path (report and fix suggestion by Nicola
Murino).</p>
</li>
<li><p class="first">Calling the method <tt class="docutils literal"><span class="pre">FTPHost.stat_cache.resize</span></tt> with an argument 0
caused an exception. This has been fixed; a zero cache size now
of course doesn't cache anything but doesn't lead to a traceback
either.</p>
</li>
<li><p class="first">The installation script <tt class="docutils literal"><span class="pre">setup.py</span></tt> didn't work with the <tt class="docutils literal"><span class="pre">--home</span></tt>
option because it still tried to install the documentation in a
system directory (report by Albrecht Mühlenschulte).</p>
<p>As a side effect, when using the <em>global</em> installation, the
documentation is no longer installed in the ftputil package
directory but in a subdirectory <tt class="docutils literal"><span class="pre">doc</span></tt> of a directory determined by
Distutils. For example, on my system (Ubuntu 9.04) the documentation
files are put into <tt class="docutils literal"><span class="pre">/usr/local/doc</span></tt>.</p>
</li>
</ul>
</div>
<div class="section" id="incompatibility-notice">
<h1>Incompatibility notice</h1>
<p>When doing a system-wide installation, the documentation files are now
placed in another location than before (see last paragraph of the
previous section). This doesn't change anything regarding the use of
the library, though.</p>
<p>Both the <tt class="docutils literal"><span class="pre">xreadlines</span></tt> method and the long-deprecated direct access
of exceptions via the <tt class="docutils literal"><span class="pre">ftputil</span></tt> module (as in
<tt class="docutils literal"><span class="pre">ftputil.PermanentError</span></tt>) will be removed in ftputil <em>2.5</em>. Starting
with that version, exception classes will only be accessible via the
<tt class="docutils literal"><span class="pre">ftp_error</span></tt> module.</p>
<p>The distribution contains a small tool <tt class="docutils literal"><span class="pre">find_deprecated_code.py</span></tt> to
scan a directory for the deprecated uses. Invoke the program with the
<tt class="docutils literal"><span class="pre">--help</span></tt> option to see a description.</p>
</div>
<div class="section" id="documentation">
<h1>Documentation</h1>
<p>The documentation for ftputil can be found in the file ftputil.txt
(reStructuredText format) or ftputil.html (recommended, generated
from ftputil.txt).</p>
</div>
<div class="section" id="prerequisites">
<h1>Prerequisites</h1>
<p>To use ftputil, you need Python, at least version 2.3. Python is a
programming language, available from <a class="reference external" href="http://www.python.org">http://www.python.org</a> for free.</p>
</div>
<div class="section" id="installation">
<h1>Installation</h1>
<ul>
<li><p class="first"><em>If you have an older version of ftputil installed, delete it or move
it somewhere else, so that it doesn't conflict with the new version!</em></p>
</li>
<li><p class="first">Unpack the archive file containing the distribution files. If you
had an hypothetical ftputil version 1.2, you would type at the shell
prompt:</p>
<blockquote>
<p>tar xzf ftputil-1.2.tar.gz</p>
</blockquote>
<p>However, if you read this, you probably unpacked the archive already. ;-)</p>
</li>
<li><p class="first">Make the directory to where the files were unpacked your current directory.
Consider that after unpacking, you have a directory ftputil-1.2. Make it
the current directory with</p>
<blockquote>
<p>cd ftputil-1.2</p>
</blockquote>
</li>
<li><p class="first">Type</p>
<blockquote>
<p>python setup.py install</p>
</blockquote>
<p>at the shell prompt. On Unix/Linux, you have to be root to perform the
installation. Likewise, you have to be logged in as administrator if you
install on Windows.</p>
<p>If you want to customize the installation paths, please read
<a class="reference external" href="http://docs.python.org/inst/inst.html">http://docs.python.org/inst/inst.html</a> .</p>
</li>
</ul>
<p>If you have easy_install installed, you can install the current
version of ftputil directly from the Python Package Index (PyPI)
without downloading the package explicitly.</p>
<ul>
<li><p class="first">Just type</p>
<blockquote>
<p>easy_install ftputil</p>
</blockquote>
<p>on the command line. You'll probably need root/administrator
privileges to do that (see above).</p>
</li>
</ul>
</div>
<div class="section" id="license">
<h1>License</h1>
<p>ftputil is Open Source Software. It is distributed under the
new/modified/revised BSD license (see
<a class="reference external" href="http://www.opensource.org/licenses/bsd-license.html">http://www.opensource.org/licenses/bsd-license.html</a> ).</p>
</div>
<div class="section" id="authors">
<h1>Authors</h1>
<p>Stefan Schwarzer &lt;<a class="reference external" href="mailto:sschwarzer&#64;sschwarzer.net">sschwarzer&#64;sschwarzer.net</a>&gt;</p>
<p>Evan Prodromou &lt;<a class="reference external" href="mailto:evan&#64;bad.dynu.ca">evan&#64;bad.dynu.ca</a>&gt; (lrucache module)</p>
<p>Please provide feedback! It's certainly appreciated. :-)</p>
</div>
</div>
</body>
</html>