Cloud Export

######################################################################## # # Project: Cloud Export # URL: http://www.nabber.org/projects/ # E-mail: webmaster@nabber.org # # Copyright: (C) 2007-2010, Neil McNab # License: GNU General Public License Version 2 # (http://www.gnu.org/copyleft/gpl.html) # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # Filename: $URL: https://appupdater.svn.sourceforge.net/svnroot/appupdater/trunk/README.txt $ # Last Updated: $Date: 2008-09-10 12:07:26 -0700 (Wed, 10 Sep 2008) $ # Author(s): Neil McNab # # Description: # This file contains overview information on the project. # ######################################################################## VERSION: 0.1 1. INTRODUCTION 2. INSTALLATION 2.1. Windows Installer 2.2. Python Installer 2.3. Portable (USB Drive) Installation 3. TYPICAL USAGE 3.1. Command line 3.2. Running from Source 3.3. Graphical User Interface (GUI) 4. COMPLETE DOCUMENTATION 4.1. Command line 4.2. Graphical User Interface (GUI) 5. SUPPORTED CLOUD SERVICES 5.1. Google 5.2 Google Apps 5.3. Twitter 5.4. Identi.ca 5.5. RSS 5.6. XMPP/Jabber 5.7. IMAP 5.8. OFX 5.9. Financial Institutions via OFX 6. KNOWN ISSUES 1. INTRODUCTION =============== Cloud Export is a tool to extract your data from web applications and save to your local file system. 2. INSTALLATION =============== 2.1. Windows Installer ---------------------- You can either run the Windows installer program or see the next section on the Python Installer. The Windows installer requires administrator privileges and can be run silently by using the /S option. 2.2. Python Installer --------------------- You need to install Python first. Check BUILD.txt for any dependencies you may need to install. This application should work on any OS. python setup.py install 2.3. Portable (USB Drive) Installation -------------------------------------- There are three ways that this can be done. 1. The recommended way to do this is to download the file that ends in -win32.zip. This contains all of the program .exes that you need, you can unzip to any directory and it will work. 2. Simply install normally to your hard drive as described in part 2.1. Then copy the installation folder (default C:\Program Files\Cloud Export) to your USB device. 3. If you want to install directly to the USB device you can, however you should uncheck all optional components to minimize unneeded changes to your Windows installation. 3. TYPICAL USAGE ================ 3.1. Command line ----------------- A single command will backup to your system: cloudexport -l username@gmail.com -p <password> To save to a specific directory: cloudexport -l username@gmail.com -p <password> --path=c:\user\username\Desktop\backup 3.2. Running from Source ------------------------ You need to install Python first. Unzip the package files and then run the program: python cloudexport.py (command line) python cloudexportw.py (GUI) 3.3. Graphical User Interface (GUI) ----------------------------------- Cloud Export now ships with a GUI, you can run it by typing the following: cloudexportw 4. COMPLETE DOCUMENTATION ========================= 4.1. Command line ----------------- Usage: CloudExport -l <login> -p <password> [options] contacts|gmail|reader| ocs|picasa|blogger Options: --version show program's version number and exit -h, --help show this help message and exit -l LOGIN, --login=LOGIN Google Account login name -p PASSWORD, --password=PASSWORD Google Account Password --path=PATH Path to backup files to (default: current directory) -i, --import Import backup into cloud (experimental) --imap=IMAP IMAP SSL server name for Gmail (default: imap.gmail.com) -g Backup data in Google's native GData format By default Cloud Export will attempt to backup from all services. You can specify exactly which services you want to backup from by space separating them on the command line like: cloudexport -l <login> -p <password> gmail blogger 4.2 Graphical User Interface (GUI) ---------------------------------- Cloud Export ships with a GUI based on Tcl/Tk. This is the most compatible GUI because python.org ships with it included. 5. SUPPORTED CLOUD SERVICES =========================== 5.1. Google ----------- - Contacts - Gmail - Reader - Picasa - Blogger - Health - Finance - Calendar - Talk - Docs 5.2. Google Apps ---------------- - Contacts - Gmail - Calendar - Talk - Docs 5.3. Twitter ------------ - RSS 5.4. Identi.ca -------------- - RSS 5.5. RSS -------- - RSS 5.6. XMPP/Jabber ---------------- - XMPP 5.7. IMAP ---------------- - IMAP 5.8. OFX -------- - OFX 5.9. Financial Institutions via OFX ----------------------------------- - Numerous, see http://www.ofxhome.com/index.php/home/directory/all. 6. KNOWN ISSUES =============== - Due to an NSIS limitation, your PATH statment cannot be longer than 1024 characters. If it is it will be ignored on install and you will have to add it to your system path manually.