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 Request auth objects:

from requests.auth import HTTPBasicAuth
orthanc.reset(auth=HTTPBasicAuth('orthanc', 'orthanc'))

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.3.3.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

orthanc_rest_client-0.3.3-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: orthanc_rest_client-0.3.3.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.2

File hashes

Hashes for orthanc_rest_client-0.3.3.tar.gz
Algorithm Hash digest
SHA256 7637e023e360f3ebb2aaa9bcabdd3b525e60f9a31c8d32112e1b5ac6cd791ab2
MD5 95db8fc7488fc1d17cb5ec356eed17a0
BLAKE2b-256 bdc396a9a28ba54e4cd005e85c28a0809c78c94c173bcd365c6e0d6802e5d4c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: orthanc_rest_client-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.2

File hashes

Hashes for orthanc_rest_client-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 15c661295650a0de56b982eaa68bee3157429e78c88d5c63ee033308fe0d9f32
MD5 25a4660dd46eb4d2ad411def45976237
BLAKE2b-256 f4dc2d0302a14f02f38d75ae20d3f09717a2f60cf3175b49558e98c7964890f6

See more details on using hashes here.

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