Skip to main content

Python client for SynGlue

Project description

git clone https://github.com/the-ahuja-lab/SynGlue.git

SynGlue API Client

SynGlue is a minimal Python client for the SynGlue web API at https://synglue.ahujalab.iiitd.edu.in/. It allows you to submit design and screen jobs, check job status, and download results programmatically.

Installation

Install the package and its only dependency:

pip install synglue requests

Usage Example

from synglue import SynGlue

# Initialize the client
client = SynGlue()

# Submit a design job
result = client.submit_design(target="EGFR", threshold=80)
print(result)

# Check job status
status = client.design_status(job_id=result["job_id"])
print(status)

# Download results (when job is complete)
# client.download_design(job_id=result["job_id"], out_path="results.zip")

Methods

  • submit_design(target, threshold=75.0)
  • design_status(job_id)
  • download_design(job_id, out_path)
  • submit_screen(molecules)
  • submit_screen_csv(csv_path)
  • screen_status(job_id)
  • download_screen(job_id, out_path)
  • health_check()

See the source code for full method documentation.

Prerequisites

  • Python 3.7 or higher
  • requests (for API calls)

License

SynGlue is licensed under the MIT License. See LICENSE for more details.

Dependencies

Prerequisites

  • Python 3.7 or higher
  • requests (for API calls)

Install the required package:

pip install requests

No other dependencies are required for the SynGlue API client.

License

SynGlue is licensed under the MIT License. See LICENSE for more details.

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

synglue-0.1.1.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

synglue-0.1.1-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file synglue-0.1.1.tar.gz.

File metadata

  • Download URL: synglue-0.1.1.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.20

File hashes

Hashes for synglue-0.1.1.tar.gz
Algorithm Hash digest
SHA256 39ff2b1fa1baa96776daf37c2b457d80652b913db21bc5246169708d80352706
MD5 fd4382ff5b1c2a7867dbde3be327fc65
BLAKE2b-256 49e666b5beaa5eced2d356b9726dbdb8f7c08c6e70ad8da42bd467b000285c7d

See more details on using hashes here.

File details

Details for the file synglue-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: synglue-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.20

File hashes

Hashes for synglue-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08e82480df62ab6c6f2a3a9471b2dc6ce4ee9dd0b04702947c00265329995c5d
MD5 b77cf0cc9f204955165383b260a2c3e3
BLAKE2b-256 2b12cb28c753ed58eed402cb207ac23799a3580c8960b6b35d397c2a6bd17d54

See more details on using hashes here.

Supported by

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