Highrise Backup

Backup Highrise Python
2009-12-04

I no longer use Highrise, but when I did, I used this Python script to back up my contacts. Hope it’s helpful to someone.

Updated 2009-12-14: Added license

#!/usr/bin/python
#
# Copyright (c) 2009, Andrew Ferrier All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * The name of Andrew Ferrier may not be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

import httplib2
import getopt
import sys

try:
    opts, args = getopt.getopt(sys.argv[1:], "a:d:", ["user-auth-token=", "domain="])
except getopt.GetoptError, err:
    print str(err)
    sys.exit(2)
userauthtoken = None
domain = None
for o, a in opts:
    if o in ("-a", "--user-auth-token"):
        userauthtoken = a
    elif o in ("-d", "--domain"):
        domain = a
    else:
        assert False, "unhandled option"

if userauthtoken == None or domain == None:
    print "You must specify both the user-auth-token and the domain"
    sys.exit(2)

url = "http://" + domain + ".highrisehq.com/people.xml"

http = httplib2.Http()

http.add_credentials(userauthtoken, "x")

offset = 0
content = ""

while True:
    response, newContent = http.request(url + "?n=" + str(offset))

    if response.status != 200:
        sys.exit(response.status)

    numContacts = newContent.count("")
    offset += numContacts
    content += newContent

    if numContacts < 500:
        break

print content

Comments

Anton, you're right. Have added one now. Thanks for the thought.
You should probably say what someone is allowed to do with this code - obviously you intend to allow someone to use it, but what about modify or redistribute it? Why not give it a specific license - GPL,BSD,CC,public domain, etc.