python-goclio

(in-development) Python Client for GoClio api

You are able to use the build in session object which will provide a simple wrapper for getting an OAuth2 token from goclio.

Or you can use this goclio module in conjunction with https://github.com/omab/python-social-auth Use the oauth2 implementation for the goclio backend.

Either of these processes will then provide you with access to the ":token" which is the oauth2 token mentioned in the examples below.

Installation

git clone https://github.com/rosscdh/python-goclio.git
cd python-goclio
python setup.py install

#
# Create an OAuth2 Session token
#
from goclio.clio import Session
#
# Please Note if you are in Europe you will need to use the
# EUSession Object
# from goclio.clio import EUSession as Session
#

CLIENT_KEY = ':your_client_id'
CLIENT_SECRET = ':your_client_secret'

s = Session(client_id=CLIENT_KEY,
            client_secret=CLIENT_SECRET,
            redirect_uri='https://yourserver.com/oauth2/code')

#
# Follow the url below, complete the process and copy the "code=:code_value" in the url
# this :code_value is then passed into the s.token_from_code(code=:code_value)
#
print s.auth_url
>>> 'https://app.goclio.com/oauth/authorize?scope=%2Foauth%2Fauthorize&redirect_uri=None&response_type=code&client_id=:your_client_id'

#
# complete the process at the above url which will result in a code being presented to you.
#

token = s.token_from_code(code=':code')

# you can also access the token via
s.access_token  # Will give you access to the token

#
# Use the token provided above to use the api in the following manner
#


from goclio.clio import Me
s = Me(session=s)
s.get()


from goclio.clio import Matters
s = Matters(session=s)
s.get()


#
# Create a matter
#
from goclio.clio import Matters
m = Matters(session=s)
m.post(client_id=882801947, description='a test matter', status='Open')


#
# Get single matter
#
from goclio.clio import Matters
m = Matters(session=s, id=1025003373)
m.get()


from goclio.clio import Documents
dd = Documents(session=s)
dd.get()


from goclio.clio import Documents
d = Documents(session=s, id=28745759)
d.document_versions()
d.download_version(version_id=30613503)

d.get()
v = d.version(version_id=30613503)

from goclio.clio import DocumentCategories
dc = DocumentCategories(session=s)
dc.get()


from goclio.clio import Contacts
c = Contacts(session=s)
c.get()

from goclio.clio import Notes
n = Notes(session=s)
n.get()

from goclio.clio import Activities
a = Activities(session=s)
a.get()

from goclio.clio import Bills
b = Bills(session=s)
b.get()

Pagination

As per the goclio docs (http://api-docs.clio.com/v2/index.html#rest-api)

from goclio.clio import Matters
m = Matters(session=s)
next_page = m.get(next_offset=:next_offset_from_previous_json_response_aata)

To paginate and basically do anythign via GET params (as per goclio api docs) pass in the desired param arguments as keyword arguments i.e. "s.get(offset=2)".

ToDo

1. Self contained session to provideo oauth2 token
2. Examples of pagination and other api operators
3. Tests