source: README.md @ 1556:2fd69205fd0a

Last change on this file since 1556:2fd69205fd0a was 1556:2fd69205fd0a, checked in by Stefan Schwarzer <sschwarzer@…>, 6 years ago
README.md edited online with Bitbucket
File size: 2.7 KB
Line 
1# ftputil #
2
3ftputil is a high-level FTP client library for the Python programming
4language. ftputil implements a virtual file system for accessing FTP
5servers, that is, it can generate file-like objects for remote files.
6The library supports many functions similar to those in the os,
7os.path and shutil modules. ftputil has convenience functions for
8conditional uploads and downloads, and handles FTP clients and servers
9in different timezones.
10
11## Documentation ##
12
13The documentation for ftputil can be found at http://ftputil.sschwarzer.net/trac/wiki/Documentation .
14
15## Requirements ##
16
17To use ftputil, you need Python, at least version 2.6. Python 3.x
18versions work as well. Python is a programming language, available
19from http://www.python.org for free.
20
21## Installation ##
22
23*If you have an older version of ftputil installed, delete it or
24move it somewhere else, so that it doesn't conflict with the new
25version!*
26
27### With pip or easy_install ###
28
29If you have pip or easy_install available, you can install the current
30version of ftputil directly from the Python Package Index (PyPI)
31without downloading the package explicitly. You'll still need an
32internet connection, of course.
33
34Just type
35
36    pip install ftputil
37 
38  or
39 
40    easy_install ftputil
41 
42on the command line, respectively. Unless you're installing ftputil
43in a virtual environment, you'll probably need root/administrator
44privileges to do that.
45 
46Done. :-)
47
48### From archive tarball ###
49
50If you have neither pip nor easy_install, you need to download a tarball
51from the [Python package index](https://pypi.python.org/pypi/ftputil) or from the [ftputil website](http://ftputil.sschwarzer.net/Download) and install it as follows.
52
53Unpack the archive file containing the distribution files. If you
54had an ftputil version 2.8, you would type at the shell prompt:
55
56    tar xzf ftputil-2.8.tar.gz
57
58Make the directory to where the files were unpacked your current
59directory. Assume that after unpacking, you have a directory
60`ftputil-2.8`. Make it the current directory with
61
62    cd ftputil-2.8
63
64Type
65
66    python setup.py install
67
68at the shell prompt. On Unix/Linux, you have to be root to perform
69the installation. Likewise, you have to be logged in as
70administrator if you install on Windows.
71
72If you want to customize the installation paths, please read
73http://docs.python.org/inst/inst.html .
74
75## License ##
76
77ftputil is open source software. It is distributed under the
78new/modified/revised BSD license (see
79http://opensource.org/licenses/BSD-3-Clause ).
80
81## Authors ##
82
83Stefan Schwarzer <sschwarzer@sschwarzer.net>
84
85Evan Prodromou <evan@bad.dynu.ca> (lrucache module)
86
87Please provide feedback! It's certainly appreciated. :-)
Note: See TracBrowser for help on using the repository browser.