README.md

hyacinth

Python HTTP Client library for the Clio Manage API

Features

• OAuth2 token + refresh support
• Pagination via Cursors
• Rate limiting (by token)
• Multi-part Document uploads
• Blocking and async Document uploads
• Clio Regions (US, CA, EU, and AU)

Usage

Clone hyacinth repository to your local environment:

git clone git@github.com:LegalMate/hyacinth.git

Install hyacinth in your project:

poetry install git:ssh//git@github.com/LegalMate/harmonia.git

Import hyacinth:

import hyacinth

Create a Session:

s = hyacinth.Session(client_id=<client_id>,
                     client_secret=<client_secret>,
                     token=<token>)

Use the Session:

me = s.get_who_am_i()
print(me)

=> {'id': 350963386, 'etag': '"14eb46ba60ce9c2e6a68f6d0d2c36334"', 'name': 'Anson MacKeracher'}

Development

If you'd like to contribute to hyacinth's development, here's how to get your environment set up:

poetry install

Feel free to submit a Pull Request with any changes. Things are low-key, and low-process for the time being. Don't be a stranger!

Tests

Run the test suite via:

poetry run poe test