Skip to main content

REST client for Orthanc DICOM servers

Project description

Provides a REST client targeted at Orthanc REST API endpoints.

Based on the excellent apiron library.

Install

pip install orthanc-rest-client

How to use

Import the pre-defined client and pass the server details

from orthanc_rest_client import Orthanc
orthanc = Orthanc('http://localhost:8042')

# Patient endpoints
orthanc.get_patients()
orthanc.get_patient(id)
...and so on

# Study endpoints
orthanc.get_studies()
orthanc.get_study(id)
...and so on

# Series endpoints
orthanc.get_series()
orthanc.get_one_series(id)
...and so on

# Instance endpoints
orthanc.get_instances()
orthanc.get_instance(id)
...and so on

# Get changes
orthanc.get_changes()

# Find objects by query
orthanc.find(query)

# Get previous queries
orthanc.get_queries()

There are other preconfigured endpoints.

Authenticated Endpoints

Pass valid auth object:

from requests.auth import HTTPBasicAuth
auth = HTTPBasicAuth('orthanc', 'orthanc')
orthanc = Orthanc('https://test.server.com', auth=auth)

Then call functions normally (the auth object is passed automatically).

For further help: - apiron - Orthanc documentation and Orthanc REST API

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

orthanc_rest_client-0.5.1.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

orthanc_rest_client-0.5.1-py3-none-any.whl (26.0 kB view details)

Uploaded Python 3

File details

Details for the file orthanc_rest_client-0.5.1.tar.gz.

File metadata

  • Download URL: orthanc_rest_client-0.5.1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for orthanc_rest_client-0.5.1.tar.gz
Algorithm Hash digest
SHA256 e81e6466dd55c1359323ba7fcc0d7868f25029f1b24f960a0f1709b4376d7375
MD5 24d715f912dfb377c31bf3eadda32b57
BLAKE2b-256 8958e1f3f35d3f968193510646e7f4f31e249a28948530ec495587faff34d9c2

See more details on using hashes here.

Provenance

File details

Details for the file orthanc_rest_client-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: orthanc_rest_client-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 26.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for orthanc_rest_client-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f836f5eeceb4958f20d5ab956618a10e14bb9e783a22a0413ed03ea93ce3c95b
MD5 7c28923c534e8fa44715a959d0b3ca05
BLAKE2b-256 03aff480ec734460f1e99bce3fd31e0b14adbfdcada20dc43633b2ce21b59b53

See more details on using hashes here.

Provenance

Supported by

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