Go to the Download Page to download the binary package for the platform of your choice. You can then refer to your platform (Win/Linux or Mac OSX) installation instructions to perform the Gmvault installation.

For the Windows, MacOSX standard distributions and Linux binary packages, the target machine doesn't need to have pre-installed a compliant Python distribution as these packages embed a working Python distribution.
Only the source distribution will need a pre-installed Python distribution.
Gmvault has been heavily tested with Python 2.6.x and Python 2.7.x versions. Please use one of these versions to run Gmvault.
Note that Gmvault might work with an older (v2.5) or newer (3.x) Python version but it has not been tested.

Double click on gmvault_setup.exe to launch it. You should see the follow screens when installing:

Note that Gmvault is installed with standard user privileges.
This means that you will not be able to install it in areas necessitating Admin privileges like for instance C:\Program Files.
The Gmvault installer should have now installed a Gmvault-shell from where you can easily launch gmvault.bat.
Gmvault-shell can be launched via a Desktop shortcut. Alternatively, you can also find it in the Gmvault folder of the Windows start-up menu.

Double click on the Desktop shortcut to launch the Gmvault-shell that will set all variables in order to easily operate Gmvault.

Type gmvault -h to start using Gmvault.

Go to Gmail Setup to configure Gmail before starting to use Gmvault.
Go to Quick Start to quickly understand how to use Gmvault.
Go to In Depth to understand all the Gmvault capabilities.

Download and untar the Mac OSX binary tarball.
Go to the GMVAULT_HOME/bin dir to launch Gmvault.

$ tar zxvf gmvault-v1.7-beta-macosx-intel.tar.gz
$ cd gmvault-v1.7-beta/bin
$./gmvault sync myuser@gmail.com

The current Mac OS X distribution has been tested with OSX 10.7 and 10.6. If you have older Intel MAC OSX version try to use this binary distribution. Please go to the Report a problem page to signal any issues. Another alternative is to download and install the source distribution or to install Gmvault from Pypi.

On Linux, it is recommended to install Gmvault using the source distribution or Pypi. There is an experimental 64bits binary tarball distribution. If you encounter a problem please report it here. Download and untar the binary tarball for Linux 64bits.
Go to the GMVAULT_HOME/bin dir to launch Gmvault.

$ tar zxvf gmvault-v1.7-beta-linux-i686.tar.gz
$ cd gmvault-v1.7-beta/bin
$ ./gmvault sync myuser@gmail.com

It is also possible to install Gmvault using the standard Python package installation method from Pypi. This is working for all platforms.
You would need to have the setup tools or pip installed in your Python distribution. I would also recommend using gmvault in a virtualenv isolated sandbox.
Below is described an installation under a virtualenv sandbox.

$ virtualenv --no-site-packages gmvault-1.7-beta
New python executable in gmvault-1.7-beta/bin/python
Installing setuptools............done.
$ cd gmvault-1.7-beta/bin
$./pip install gmvault
Downloading/unpacking gmvault
  Downloading gmvault-1.7-beta.tar.gz (47Kb): 47Kb downloaded
  Running setup.py egg_info for package gmvault

Downloading/unpacking Logbook==0.3 (from gmvault)
  Downloading Logbook-0.3.tar.gz (89Kb): 89Kb downloaded
  Running setup.py egg_info for package Logbook

Downloading/unpacking IMAPClient==0.8.1 (from gmvault)
  Downloading IMAPClient-0.9.zip (107Kb): 107Kb downloaded
  Running setup.py egg_info for package IMAPClient
    Downloading http://pypi.python.org/packages/source/d/distribute/distribute-0.6.24.tar.gz
    Extracting in /tmp/tmp2kCczm
    Now working in /tmp/tmp2kCczm/distribute-0.6.24
    Building a Distribute egg in /tmp/gmvault-1.0-beta/build/IMAPClient
    warning: no files found matching 'Makefile' under directory 'docs'
    warning: no files found matching 'indexsidebar.html' under directory 'docs'

    no previously-included directories found matching 'doc/doctrees'
Downloading/unpacking gdata==2.0.17 (from gmvault)
  Downloading gdata-2.0.17.tar.gz (2.4Mb): 2.4Mb downloaded
  Running setup.py egg_info for package gdata

Installing collected packages: gdata, gmvault, IMAPClient, Logbook
  Running setup.py install for gdata

  Running setup.py install for gmvault
    changing mode of build/scripts-2.7/gmvault from 644 to 755

    changing mode of /tmp/gmvault-1.7-beta/bin/gmvault to 755
  Running setup.py install for IMAPClient

    no previously-included directories found matching 'doc/doctrees'
  Running setup.py install for Logbook
    building 'logbook._speedups' extension
    gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC -I/homespace/gaubert/python2.7/include/python2.7 -c logbook/_speedups.c -o build/temp.linux-i686-2.7/logbook/_speedups.o
    gcc -pthread -shared build/temp.linux-i686-2.7/logbook/_speedups.o -o build/lib.linux-i686-2.7/logbook/_speedups.so

Successfully installed gdata gmvault IMAPClient Logbook
Cleaning up...

Alternatively to pip, easy_install could also be used but we recommend using pip.

The Source distribution is a standard python distribution installation. It is very similar to the installation from Pypi and working on all platforms.
It is also recommended to use Gmvault within a virtualenv (see here for info). Untar the downloaded source distribution and run:

$> cd gmvault-1.7-beta
$> ~/virtualenv-test/bin/python setup.py install
PATH = ./src/gmv/gmv_cmd.py

Gmvault version = 1.7-beta

running install
running bdist_egg
running egg_info
writing requirements to gmvault.egg-info/requires.txt
writing gmvault.egg-info/PKG-INFO
writing top-level names to gmvault.egg-info/top_level.txt
writing dependency_links to gmvault.egg-info/dependency_links.txt
reading manifest file 'gmvault.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'gmvault.egg-info/SOURCES.txt'
installing library code to build/bdist.macosx-10.7-intel/egg
running build_scripts
creating build/scripts-2.7
copying ./etc/scripts/gmvault -> build/scripts-2.7
Installing gmvault script to /Users/xxxx/virtualenv-test/bin

Installed /Users/xxxx/virtualenv-test/lib/python2.7/site-packages/gmvault-1.7_beta-py2.7.egg
Processing dependencies for gmvault==1.7-beta
Searching for gdata==2.0.17
Reading http://pypi.python.org/simple/gdata/
Reading http://code.google.com/p/gdata-python-client/
Best match: gdata 2.0.17
Downloading http://gdata-python-client.googlecode.com/files/gdata-2.0.17.zip
Processing gdata-2.0.17.zip
Running gdata-2.0.17/setup.py -q bdist_egg --dist-dir /var/folders/w3/kzry2_2537bbjd9_pwyjsnlw0000gn/T/easy_install-Zg1PBK/gdata-2.0.17/egg-dist-tmp-_kskLT
zip_safe flag not set; analyzing archive contents...
Adding gdata 2.0.17 to easy-install.pth file
Finished processing dependencies for gmvault==1.6-beta

Please report any problems using "Report a problem" page.

Once you have installed Gmvault (see Install), please go to Gmail Setup to configure Gmail to working optimally with Gmvault.
You can alternatively go to Quick Start to start using Gmvault in 2 mins.