# Slide Score Python SDK
This SDK contains the client library for using API of [Slide Score](https://www.SlideScore.com)
See the [documentation](https://www.slidescore.com/docs/api/index.html) for more
# Examples
For more examples see the examples folder
## Basic usage
- Import the module
- setup token
- setup URL of the Slide Score server
- 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);
Raw data
{
"_id": null,
"home_page": "https://github.com/SlideScore/SlideScore-python-sdk",
"name": "slidescore-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "slidescore, slide score, sdk, api",
"author": "Slide Score B.V.",
"author_email": "info@slidescore.com",
"download_url": "https://files.pythonhosted.org/packages/0b/41/b969cc8a62eacb30ced37aac1401989a60180d4d02eeead21c42e0aad036/slidescore-sdk-1.4.6.tar.gz",
"platform": null,
"description": "# Slide Score Python SDK\n\nThis SDK contains the client library for using API of [Slide Score](https://www.SlideScore.com)\t\nSee the [documentation](https://www.slidescore.com/docs/api/index.html) for more \n\n# Examples\n\nFor more examples see the examples folder\n\n## Basic usage\n\n- Import the module\n- setup token\n- setup URL of the Slide Score server\n- create an instance of the API Client\n\n from slidescore import *\n\n\n token=\"eyJ....<your token>....\"\n url=\"https://slidescore.example.com/\"\n\n client = APIClient(url, token)\n \n## Downloading a slide \n\nDownloads 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.\n\n studyid=1\n imageid=2\n\n client.download_slide(studyid, imageid, \".\")\n\n\n## Uploading and adding a slide to a study\n\n localFilePath=\"C:/file_to_upload.tiff\"\n uploadFolder=\"UploadTest\"\n serverFileName=\"renamedSlide.tiff\"\n\n client.upload_file(localFilePath, uploadFolder, serverFileName)\n client.add_slide(studyid, uploadFolder+\"/\"+serverFileName) \n \n## Upload answers - study results\n\nResults are uploaded in the same format as the download.\n\n resultsFilePath=\"c:/Users/User/Downloads/Study_23_06_21_11.txt\"\n with open(resultsFilePath, \"r\") as f:\n res = f.read()\n client.upload_results(studyid, res)\n\n\n## Set slide description\n\nYou can use (limited) set of HTML tags in slide, case, study and module descriptions:\n\n 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>');\n\n\n## Make a request directly\n\nThe SDK doesn't include methods for all possible calls, sometimes you need to make the API request yourself:\n\n response=clientlocal.perform_request(\"UpdateSlideName\", {\"imageId\":imageid, \"newName\":'renamedSlide'}, method=\"POST\")\n rjson = response.json()\n if 'success' not in rjson or rjson['success'] != True:\n raise SlideScoreErrorException(\"Failed updating slide name: \" + response.text);\n\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "SDK for using the API of Slide Score",
"version": "1.4.6",
"project_urls": {
"Homepage": "https://github.com/SlideScore/SlideScore-python-sdk"
},
"split_keywords": [
"slidescore",
" slide score",
" sdk",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4990b6389cc67101fa87b54a7be319041bae44a48fc13e4fb251c8889b0a7f02",
"md5": "bc877cc34d1499df208355d6a8410fb5",
"sha256": "c105dc1848baa0b36bc3c7ecbe91f9592f4f6bd7f474f906ac5366e8c1aa4093"
},
"downloads": -1,
"filename": "slidescore_sdk-1.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc877cc34d1499df208355d6a8410fb5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 27558,
"upload_time": "2025-01-07T20:59:36",
"upload_time_iso_8601": "2025-01-07T20:59:36.825724Z",
"url": "https://files.pythonhosted.org/packages/49/90/b6389cc67101fa87b54a7be319041bae44a48fc13e4fb251c8889b0a7f02/slidescore_sdk-1.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b41b969cc8a62eacb30ced37aac1401989a60180d4d02eeead21c42e0aad036",
"md5": "1372c342f80b185ba3bc6de5c4148f4a",
"sha256": "5f4255df5801d0cacdb3149cc3af9254ddd3fdcfc60a727ecbb24b13ab319f08"
},
"downloads": -1,
"filename": "slidescore-sdk-1.4.6.tar.gz",
"has_sig": false,
"md5_digest": "1372c342f80b185ba3bc6de5c4148f4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25204,
"upload_time": "2025-01-07T20:59:38",
"upload_time_iso_8601": "2025-01-07T20:59:38.006877Z",
"url": "https://files.pythonhosted.org/packages/0b/41/b969cc8a62eacb30ced37aac1401989a60180d4d02eeead21c42e0aad036/slidescore-sdk-1.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 20:59:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SlideScore",
"github_project": "SlideScore-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "slidescore-sdk"
}
JSON
