Skip to main content

API that interacts with Illumina Clarity LIMS REST architecture.

Project description


Provides a simple REST implementation for use with Clarity endpoints.


Was designed to implement a simple way to interact with Clarity REST architecture.


  • Get will do a batch get if that end point exists, otherwise it will return a response similar to what a batch get returns.
  • Caller can add queries to get using a keyword.
  • Caches every get to eliminate excessive get calls.
  • All REST calls will throw an exception if they failed.

Code Example

from ua_clarity_api import ua_clarity_api

api = ua_clarity_api.ClarityApi(host, username, password)
uris_files = api.download_files("some file uri")
data = api.get("some endpoint")


pip install ua-clarity-api


pip install --update nose
cd ./repo
cd ./tests

How to Use

  • You'll need to instantiate a ClarityApi object with a correct host, and the username/password to access that host's endpoints.
  • Get can retrieve resources from endpoints and can utilize queries with the "parameters" keyword.
  • Put and Post can update or create new resources given the appropriate endpoint and a well-formed payload.
  • Delete can remove a resource from an endpoint.
  • Download_files will create temporary files from a list of file uris and returns them as a dictionary mapping of uri: tempfile.


sterns1 raflopjr RyanJohannesBland



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ua_clarity_api-1.1.4.tar.gz (5.8 kB view hashes)

Uploaded source

Built Distribution

ua_clarity_api-1.1.4-py3-none-any.whl (6.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page