1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
GooBook -- Access your Google contacts from the command line.
:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::

.. contents:: **Table of Contents**

-------------------------
About
-------------------------

The purpose of GooBook is to make it possible to use your Google Contacts in
a MUA such as Mutt. It's use mimics that of abook (somewhat).

-------------------------
Installation Instructions
-------------------------

GooBook is only released as a source distribution.

It can be installed using easy_install or pip or manually with the source
tarball.

===================
easy_install or pip
===================

This is the recommended way to install goobook.
If installing this way you will not need to download the source manually.

Run easy_install or pip::

    $ easy_install -U goobook
    $ pip install goobook

easy_install is part of setuptools which should come with most distributions.


===================
Source installation
===================

Download the source tarball, uncompress it, then run the install command::

    $ tar -xzvf goobook-*.tar.gz
    $ cd goobook-*
    $ sudo python ./setup.py install

=========
Upgrading
=========

If you are upgrading from a pre 1.0 version you will have to remove the old
cachefile and create a new configuration.

-----------------------------
Configure
-----------------------------

For most users it will be enough to add an entry to your ~/.netrc::

    machine google.com
      login your@google.email
      password secret

To get access too more settings you can create ~/.goobookrc::

    [DEFAULT]
    # If not given here, email and password is taken from .netrc using
    # machine google.com
    email: user@gmail.com
    password: top secret
    # The following are optional, defaults are shown
    max_results: 9999
    cache_filename: ~/.goobook_cache
    cache_expiry_hours: 24

==============
Proxy settings
==============

If you use a proxy you need to set the https_proxy environment variable.

-----------------------------
Usage
-----------------------------

To query your contacts::

    $ goobook query QUERY

The add command reads a email from STDIN and adds the From address to your Google contacts::

    $ goobook add

The cache is updated automatically according to the configuration but you can also force an update::

    $ goobook reload

==========
Mutt Setup
==========

Set in your .muttrc file::

    set query_command="goobook query '%s'

to query address book. (Normally bound to "Q" key.)

If you want to be able to use <tab> to complete email addresses instead of Ctrl-t add this:

    bind editor <Tab> complete-query

To add email addresses (with "a" key normally bound to create-alias command)::

    macro index,pager a "<pipe-message>goobook add<return>" "add the sender address to Google contacts"

If you want to add an email's sender to Contacts, press a while it's selected in the index or pager.

-----------------------------
Feedback and getting involved
-----------------------------

- Mailing list: http://groups.google.com/group/goobook
- Issue tracker: http://code.google.com/p/goobook/issues/list
- Code Repository: http://code.google.com/p/goobook/source/checkout