r2dt-client

R2DT API Client


License
MIT
Install
pip install r2dt-client==0.1.9

Documentation

R2DT API Client

PyPI [Status][status] Static Badge

[License][license]

[pre-commit][pre-commit] [Black][black]

Features

  • Access to the [R2DT] API via Python
  • Display R2DT widget in Jupyter Notebook

Requirements

  • Python 3.9+
  • [pdm] 2.0.0+

Installation

You can install R2DT API Client via [pip] from [PyPI]:

$ pip install r2dt-client

Usage

Example usage in the code:

from time import sleep
from r2dt_client import setup, submit, update_status_for, fetch_results_for

setup(email="YOUR_EMAIL")

job = submit(
    ">S box leader))\nCTCTTATCGAGAGTTGGGCGAGGGATTTGGCCTTTTGACCCCAAAAGCAACCGACCGTAATTCCATTGTGAAATGGGGCGCATTTTTTTCGCGCCGAGACGCTGGTCTCTTAAGGCACGGTGCTAATTCCATTCAGATCTGATCTGAGAGATAAGAG")
while not job.done:
    update_status_for(job)
    sleep(5)

fetch_results_for(job)
print(job.results['fasta'])

Using the widget via Jupyter Notebook:

!pip install r2dt_client

from r2dt_client import setup, draw

setup(email="YOUR_EMAIL")
draw(
    ">S box leader))\nCTCTTATCGAGAGTTGGGCGAGGGATTTGGCCTTTTGACCCCAAAAGCAACCGACCGTAATTCCATTGTGAAATGGGGCGCATTTTTTTCGCGCCGAGACGCTGGTCTCTTAAGGCACGGTGCTAATTCCATTCAGATCTGATCTGAGAGATAAGAG")

License

Distributed under the terms of the [MIT license][license], R2DT API Client is free and open source software.

Issues

If you encounter any problems, please [file an issue] along with a detailed description.