README.md

highrise

python-highrise is a way to wrap Highrise's API Pythonically.

Installation

easy_install ElementTree https://github.com/chriscohoat/highrise/tarball/master

Usage

# Import the highrise wrapper.
from highrise.wrapper import Highrise

#Prepare the Highrise interaction with the API token and person ID
highrise_api_token = 'TOKEN_HERE'
person_highrise_id = 'PERSON_ID_HERE'
hr = Highrise('https://examplecorporation.highrisehq.com',highrise_api_token)

#Get list of notes or list of emails
notes = hr.notes(person_highrise_id)
emails = hr.emails(person_highrise_id)

Interacting with notes (using Django)

views.py

def highrise_interaction(request):

	#Prepare the Highrise interaction with the API token and person ID
	highrise_api_token = 'TOKEN_HERE'
	person_highrise_id = 'PERSON_ID_HERE'
	hr = Highrise('https://examplecorporation.highrisehq.com',highrise_api_token)

	#Get list of notes or list of emails
	notes = hr.notes(person_highrise_id)
	
	return render_to_response('template.html',{'notes':notes}, context_instance=RequestContext(request))

template.html

{% extends "base.html" %}

{% block content %}

{% if not notes %}
<h3>No notes available for this person.</h3>
{% else %}
{% for note in notes %}

<h3>Note about {{ note.subject_name }}</h3>
<h4>Added at {{ note.created_at }}</h4>
<p>
	{{ note.body }}
	<br />
	<br />
	<a href="https://examplecorporation.highrisehq.com/notes/{{ note.note_id }}" target="blank">Read More...</a>
</p>

{% endfor %}
{% endif %}

{% endblock %}

Testing

More to come with testing.