README.org 3 KB
Newer Older
1 2
Created : Wed Aug 24 22:41:42 IST 2011

3 4 5 6 7 8 9
This is only a short introduction and some key points of interest. For more
details on how to use ASynK please refer to the included documentation, or the
official website for ASynK is at: http://karra-asynk.appspot.com You will find
links to latest download, complete documentaiton, and other information on
that website.

* About
10

11 12
  ASynK - Awesome Sync (by Karra), is a flexible Contacts synchronization platform
  written in Python. High level features include:
13

14
  - ASynK allows two-way sync of Contacts across any two supported sources -
15 16
    Google Contacts, Microsoft Outlook, Microsoft Exchange Server, any CardDAV
    server and Emacs BBDB.
17 18 19 20 21 22 23 24
  
  - ASynK is the only two-way synchronization option for BBDB known to be in
    existence today. So if you are keen to keep your BBDB content synchronized
    with a mobile device or Outlook, look no further.
  
  - ASynK works on Windows, MacOS X, and Linux. Outlook synchronization
    only works on Windows.
  
25 26 27 28
  - Synchronization is granular to the level of 'Folders', i.e. you can
    synchronize one folder of Google Contacts with a Outlook folder (on
    Windows at work, say), and another Google folder in the same account with
    BBDB (On your Mac, say)
29
  
30
  - The infrastructure is there to add more database and item types
31 32
    (i.e. tasks, notes, etc.), but currently only Contacts synchronization is
    supported
33 34 35
    
  - It is free software, and released under the GNU AGPL (Affero GPL) version
    3
36

Sriram Karra's avatar
Sriram Karra committed
37 38 39 40 41
* Installation & Usage

As you are reading this file, the most efficient installation is to clone this
git repository to your machine. Then see the section titled Usage below to 
invoke ASynK.
42 43 44 45

** Dependencies

   - You need Python (tested with 2.7, try earlier versions at your
Barak A. Pearlmutter's avatar
Barak A. Pearlmutter committed
46
     discretion; may not work with Python 3)
47

48 49 50 51 52
   - The following python packages:

     - tornado
     - requests

53 54 55
   - If you wish to sync to Outlook you can do that only on Windows. Further
     you will need MS Outlook installed, along with a third party python
     library called Pywin32 from Mark Hammond
56

57 58
   - On Debian (and likely Ubuntu) you will need the following packages:
        sudo apt-get install python-argparse
59 60 61

   - The dateutil package available from http://labix.org/python-dateutil or
     https://pypi.python.org/pypi/python-dateutil
62

63
** Usage
64

65 66 67 68 69 70 71 72 73
   The recommended way to use ASynK is to first create your own 'sync profile'
   which specifies which folders and PIM DBs you want to keep in sync. Refer
   to the documentation for more details.

   For the really impatient, ASynK comes with two default sync profiles that
   kick in if no other profile is configured.
   
   $ python asynk.py --op=sync [--dry-run] [--log=debug]

74 75 76
   If you run the above command on Windows, the entire default outlook
   contacts folder will get synched to "My Contacts" on Google Contacts. (You
   will be prompted for your google username and password). 
77

78 79
   On any non-windows platform your ~/.bbdb will be synced to google.

Barak A. Pearlmutter's avatar
Barak A. Pearlmutter committed
80
   For further usage help, try "python asynk.py -h"