Skip to main content

API that interacts with Illumina's Clarity LIMS software at a higher level than requests.

Project description

UA-Lims-Tools

Provides 2 sets of tools for use with clarity and it's endpoints: ClarityTools and StepTools.

Motivation

To create a set of tools to assist in script writing for Clarity.

Features

Use ClarityTools as a means of interfacing with Clarity and it's endpoints.

  • get_samples will get all samples from a list of uris passed in.

  • get_arts_from_samples will get all artifact uris for the list of uris passed.

  • get_udfs will find all the udfs that should be attached to target.

  • set_reagent_label will set the reagent_label for all artifacts passed.

  • step_router will route a list of artifact_uris to a specified step.Use StepTools as a way of interacting with a Clarity step.*

  • get_artifacts will return all artifacts from the step.

  • get_process_data will retrieve the process data for the current step.

  • get_artifact_map creates a mapping of input artifacts to output artifacts.

  • set_artifact_udf sets the udfs of all analytes in the step.

  • get_artifacts_previous_step will map the current steps artifact uris to an ancestor artifact from the step passed to it.

  • get_assays will find the assays within the current protocol.## Code Example

python from ua_lims_tools import ua_lims_tools clarity_api = ua_lims_tools.ClarityApi() step_api = ua_lims_tools.StepTools()

Installation

bash pip install ua-lims-tools

Tests

bash pip install --update nose cd ./repo cd ./tests nosetests test_lims_tools.py

How to Use

Examples of syntax for each method

python clarity_api = ua_lims_tools.ClarityApi() samples = clarity_api.get_samples(uris)

  • get_samples gets the samples from the passed in uris.
  • Arguments: uris is a list of sample endpoints to get.
  • Returns: a list of Sample dataclass objects with gotten sample's data.

Credits

sterns1 raflopjr RyanJohannesBland

LicenseMIT

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ua_clarity_tools-1.1.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file ua_clarity_tools-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: ua_clarity_tools-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for ua_clarity_tools-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d00ee34a8dd2d412f5fedcfa213eb74524f2874d5e3ea66cf10a17714beafac
MD5 262108db6a07b2d285dd65b347a8078d
BLAKE2b-256 87b9b326b0b7db29111af1d0c351961dc71b1d150592fc04ccad524da9e0d34d

See more details on using hashes here.

Supported by

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