Metadata-Version: 2.1
Name: adit-client
Version: 0.2.2
Summary: ADIT Client library to connect to an ADIT server.
License: GPL-3.0-or-later
Author: Kai Schlamp
Author-email: kai.schlamp@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: dicomweb-client (>=0.59.1,<0.60.0)
Requires-Dist: pydicom (>=2.4.3,<3.0.0)
Description-Content-Type: text/markdown

# Adit Client

## About

Adit Client is the official Python client of [ADIT (Automated DICOM Transfer)](https://github.com/radexperts/adit).

## Usage

### Prerequisites

- Generate an API token in your ADIT profile.
- Make sure to have the permissions to access the ADIT API.
- Also make sure you have access to the DICOM nodes you want query.

### Code

```python
adit_url = "https://adit" # The host URL of adit
adit_token = "my_token" # The generated auth token
client = AditClient(server_url=adit_url, auth_token=adit_token)

# Search for studies
studies = client.search_for_studies("ORTHANC1", {"PatientName": "Doe, John"})

# The client returns pydicom datasets
study_descriptions = [study.StudyDescription for study in studies]
```

