Metadata-Version: 2.4
Name: adit-client
Version: 0.43.0
Summary: ADIT Client library to connect to an ADIT server.
Author: Kai Schlamp
License-Expression: AGPL-3.0-or-later
Requires-Python: <4.0,>=3.12
Requires-Dist: dicognito>=0.17.0
Requires-Dist: dicomweb-client>=0.59.3
Requires-Dist: pydicom>=2.4.4
Description-Content-Type: text/markdown

# ADIT Client

## About

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

## 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

```python
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]
```

## License

- AGPL 3.0 or later
