===========================================================================

Ftpcube is a graphical (S)FTP client written in Python using the wxPython
graphical toolkit, and is based on LeechFTP by Jan Debis. Ftpcube aims
to provide a high quality GUI, as well as a rich feature set, and
surpasses LeecFTP in terms of functionality.

===========================================================================

  FtpCube makes use of the wxPython toolkit for its graphical output.
This allows Ftpcube to run on Unix, Windows, and MacOS. The wxPython 2.6.3.x
version is now supported. After many email requests and my own personal
longing, SFTP is now supported, using the Paramiko SSH module. If the
Paramiko module is not installed, then SFTP function will be disabled and
only FTP function will be provided. Please see the pre-requisites section
to install other dependent software to get up and running. If you're a
Unix user on a distro that has package management, hopefully they've
resolved all this for you.

  If you have any comments, suggestions, please send them my way.

          -- Michael Gilfix <mgilfix@eecs.tufts.edu>

General notes:
==========================================================================

  The configuration format has changed since the 0.5.x versioning. Please
remove existing configuration files before running Ftpcube. If you are
a unix machine, you can just remove the hidden .ftpcube directory like
this:

    rm -rf ~/.ftpcube

If you're on a windows machine, try this at a 'cmd' prompt:

    cd %HOMEDRIVE%%HOMEPATH%
    rmdir /s "Ftpcube Config"

Installation:
==========================================================================

Pre-requisites:
-------------------------------------------------------------------------

* wxPython:

First, you'll need the wxPython GUI toolkit library. Binaries can be
obtained from the wxPython site under the 'Binaries' section on the left:

    http://www.wxpython.org/

* For SFTP support:

You'll need the Paramiko SSH library, which also requires the PyCrypto
library. The Paramiko homepage provides links to the Pycrypto library.
You can access the homepage here:

    http://www.lag.net/paramiko/

For Windows, I've found the binaries for PyCrypto to be very useful as
Python requires a specific VC compiler for compiling extensions. Much
better to just take the binary:

    http://www.voidspace.org.uk/python/modules.shtml#pycrypto

If you don't want to install the Paramiko library, Ftpcube will still
function but without SFTP suppot enabled.


Otherwise:
--------------------------------------------------------------------------

To install from source, the installation procedure makes use of python's
distutils module. If for some reason, the install fails or you don't have
the distutil module, please visit http://www.python.org to obtain
the module.

To install python in your system, do the following:

    python setup.py build
    python setup.py install

Then just run 'ftpcube' normally. Enjoy :) If something goes wrong and
you want to see debugging information, you can run the ftpcube.py with
the command-line arguments '-d' or '--debug'. A standard out/err window
will appear with debugging information about Ftpcube's actions.

If you'd like to change ftpcube's default installation locations, just
edit the 'setup.cfg' file before running a 'python setup.py install'.
The install_data field indicates where program shared data is stored on
your system. Normally, this is in /usr/share or /usr/local/share. Ftpcube
will put it's icons and translation files within this directory. The
install_script field indicates where the ftpcube executable is placed.

A Window Note:
==========================================================================

To run Ftpcube on windows, create a directory to contain the Ftpcube
application with source inside. Click on the ftpcube.pyw file. That will
perform the correct launch for windows (meaning the separate python window
will not appear). Enjoy.
