ADIT Client
About
ADIT Client is the official Python client of ADIT (Automated DICOM Transfer). It wraps the DICOMweb API of an ADIT server (QIDO-RS, WADO-RS, STOW-RS and the NIfTI extension). Transfer jobs (selective/batch transfer) are not managed through this client.
Installation
Requires Python 3.12 or newer.
pip install adit-client
# or
uv add adit-client
Usage
Prerequisites
- Generate an API token in your ADIT profile.
- Make sure you have the permissions to access the ADIT API.
- Also make sure you have access to the DICOM nodes you want query.
Code
from adit_client import AditClient
server_url = "https://adit" # The host URL of the ADIT server
auth_token = "my_token" # The authentication token generated in your profile
client = AditClient(server_url=server_url, auth_token=auth_token)
# Search for studies. The first parameter is the AE title of the DICOM server
# you want to query.
studies = client.search_for_studies("ORTHANC1", {"PatientName": "Doe, John"})
# The client returns pydicom datasets.
study_descriptions = [study.StudyDescription for study in studies]
Client options
AditClient(server_url, auth_token, verify=True, trial_protocol_id=None, trial_protocol_name=None)
verify:True/Falseto enable/disable TLS verification, or the path to a CA bundle.trial_protocol_id/trial_protocol_name: sent along with every retrieve request so the server can set the corresponding DICOM tags on the retrieved data.
Methods
Every method takes the AE title of the DICOM server as first argument.
Query (QIDO-RS), results are pydicom datasets:
search_for_studies(ae_title, query=None)search_for_series(ae_title, study_uid, query=None)search_for_images(ae_title, study_uid, series_uid, query=None)
Retrieve (WADO-RS), the retrieve_* methods return lists of pydicom datasets, the *_metadata
methods return the DICOM JSON metadata and the iter_* methods stream the datasets one by one.
They accept an optional pseudonym that makes the server pseudonymize the data before sending it:
retrieve_study(ae_title, study_uid, pseudonym=None),retrieve_study_metadata(...),iter_study(...)retrieve_series(ae_title, study_uid, series_uid, pseudonym=None),retrieve_series_metadata(...),iter_series(...)retrieve_image(ae_title, study_uid, series_uid, image_uid, pseudonym=None),retrieve_image_metadata(...)
Store (STOW-RS):
store_images(ae_title, images): uploads a list of pydicom datasets.
NIfTI, returns (filename, BytesIO) tuples (the iter_* variants stream them):
retrieve_nifti_study(ae_title, study_uid),iter_nifti_study(...)retrieve_nifti_series(ae_title, study_uid, series_uid),iter_nifti_series(...)retrieve_nifti_image(ae_title, study_uid, series_uid, image_uid),iter_nifti_image(...)
License
- AGPL 3.0 or later
1 maintainer
Metadata
1 maintainer
Release files for adit-client 0.52.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| adit_client-0.52.0.tar.gz | 35.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| adit_client-0.52.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.0 kB
Release files / adit_client-0.52.0.tar.gz
| Download URL | adit_client-0.52.0.tar.gz |
|---|---|
| Size | 35.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
33cc81d2f3733d017a86bc584222eecb45cc35fbdfd48ba35b14e2b1eb10aed0
|
|
BLAKE2b-256 checksum How to use checksums |
a1f990dd77d6c809b7bfa1fd19ebd32892f67d1cf8c586bdab0d15dbccd4b142
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.
Transparency logRelease files / adit_client-0.52.0-py3-none-any.whl
| Download URL | adit_client-0.52.0-py3-none-any.whl |
|---|---|
| Size | 5.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3b2d737580c610730331a3632ccad31d41b2146f2b4d457291ff76119626520f
|
|
BLAKE2b-256 checksum How to use checksums |
24be2df0f8bda9e615121bac77ad648d8ecc28ec0207eceedaa58784fd1b431f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.
Transparency log
