Skip to main content

SDK for using the API of Slide Score

Project description

Slide Score Python SDK

This SDK contains the client library for using API of Slide Score See the documentation for more

Examples

For more examples see the examples folder

Basic usage

Import the module and use the token and Slide Score server URL to create an instance of the API Client:

from slidescore import *
token="eyJ....<your token>...."
url="https://slidescore.example.com/"
client = APIClient(url, token)

Downloading a slide

Downloads a slide to the current directory ("."). Check the URL of the slide for image ID and study ID, or click Export cases button on study overview to get a list of slide IDs.

studyid=1
imageid=2

client.download_slide(studyid, imageid, ".")

Uploading and adding a slide to a study

localFilePath="C:/file_to_upload.tiff"
uploadFolder="UploadTest"
serverFileName="renamedSlide.tiff"

client.upload_file(localFilePath, uploadFolder, serverFileName)
client.add_slide(studyid, uploadFolder+"/"+serverFileName) 

Upload answers - study results

Results are uploaded in the same format as the download.

resultsFilePath="c:/Users/User/Downloads/Study_23_06_21_11.txt"
with open(resultsFilePath, "r") as f:
    res = f.read()
client.upload_results(studyid, res)

Set slide description

You can use (limited) set of HTML tags in slide, case, study and module descriptions:

client.update_slide_description(studyid, imageid, 'Carina Nebula: Cosmic Cliffs, Glittering Landscape of Star Birth. Image Credit: NASA, ESA, CSA, and STScI <a href="https://esawebb.org/news/weic2205/">Original</a>');

Make a request directly

The SDK doesn't include methods for all possible calls, sometimes you need to make the API request yourself:

response=clientlocal.perform_request("UpdateSlideName", {"imageId":imageid, "newName":'renamedSlide'}, method="POST")
rjson = response.json()
if 'success' not in rjson or rjson['success'] != True:
    raise SlideScoreErrorException("Failed updating slide name: " + response.text);

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

slidescore_sdk-1.4.7.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

slidescore_sdk-1.4.7-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file slidescore_sdk-1.4.7.tar.gz.

File metadata

  • Download URL: slidescore_sdk-1.4.7.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for slidescore_sdk-1.4.7.tar.gz
Algorithm Hash digest
SHA256 e848fd2365982f8cd64ab13d4368e560b0fbf71e119527e62492796ebf07d18b
MD5 2279868a2e5c16938b67fc31535bfe88
BLAKE2b-256 78c64d587bacd52514b98eec42ec738fd95507dd083aae0f697685f5b330587d

See more details on using hashes here.

File details

Details for the file slidescore_sdk-1.4.7-py3-none-any.whl.

File metadata

  • Download URL: slidescore_sdk-1.4.7-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for slidescore_sdk-1.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a26649983998f18f29840948aa854814398f50479021d3824a827e0f8472bb68
MD5 2c7707cdbc21b830f8c2d94197064251
BLAKE2b-256 e3389197eccfae7cc49a935a908be7fb630d2d378b2dfc9ed892dc74ee8ddd0b

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