Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ch00k/orthanc-rs
REST API client for Orthanc, an open-source, lightweight DICOM server
https://github.com/ch00k/orthanc-rs
api cli client command-line dicom medical medical-imaging orthanc rest rust
Last synced: about 1 month ago
JSON representation
REST API client for Orthanc, an open-source, lightweight DICOM server
- Host: GitHub
- URL: https://github.com/ch00k/orthanc-rs
- Owner: Ch00k
- License: unlicense
- Created: 2020-08-27T07:02:09.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T17:03:03.000Z (almost 2 years ago)
- Last Synced: 2024-04-29T15:06:14.875Z (7 months ago)
- Topics: api, cli, client, command-line, dicom, medical, medical-imaging, orthanc, rest, rust
- Language: Rust
- Homepage:
- Size: 255 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://crates.io/crates/orthanc)
[](https://docs.rs/orthanc)
[](https://github.com/Ch00k/orthanc-rs/actions)
[](https://codecov.io/github/Ch00k/orthanc-rs)
[](./UNLICENSE)
# orthanc-rs
**orthanc-rs** is a client for the [REST API](https://book.orthanc-server.com/users/rest.html)
of [Orthanc](https://book.orthanc-server.com/users/rest.html), an open-source, lightweight
DICOM server.
## Compatibility
Supported Orthanc versions are 1.6.x, 1.7.x, 1.8.x, 1.9.x.
## Installation
To use the crate, add the dependency to your `Cargo.toml`:
```ini
[dependencies]
orthanc = "0.8.0"
```
## Usage
Create an API client instance:
```rust
use orthanc::Client;
let client = Client::new("http://localhost:8042");
```
If authentication is enabled on the Orthanc instance:
```rust
client.auth("username", "password");
```
List patients:
```rust
client.patients();
```
Or in an expanded format:
```rust
client.patients_expanded();
```
Get all DICOM tags of an instance:
```rust
let instance_id = "0b62ebce-8ab7b938-e5ca1b05-04802ab3-42ee4307";
let tags = client.instance_tags(instance_id);
println!("{}", tags["PatientID"]);
```
Download a study:
```rust
let study_id = "9357491d-427a6c94-4080b6c8-1997f4aa-af658240";
let mut file = fs::File::create("/tmp/study.zip").unwrap();
client.study_dicom(study_id, &mut file).unwrap();
```
Even though the operation is not very efficient, Orthanc allows uploading DICOM files over REST API:
```rust
let data = fs::read("/tmp/instance.dcm").unwrap();
client.upload(&data).unwrap();
```
See `tests` directory for more usage examples.
## Tests
orthanc-rs is covered by unit as well as integration and end-to-end tests.
To run all tests execute
```
$ make start_services && make test
```
Running specific test suits separately is described below.
### Unit
To run unit tests execute
```
$ make unit_test
```
### Integration
To run unit tests execute
```
$ make integration_test
```
### End-to-end
Install [docker-compose](https://docs.docker.com/compose) and
[jq](https://stedolan.github.io/jq) and execute
```
$ make start_services && make e2e_test
```
This will spin up all the necessary services required for integration tests, and run the tests.
During and after the test run Orthanc web UI is available at http://localhost:8028 (username: _orthanc_, password:
_orthanc_).
Containers started by `start_services` are left running after the test is finished. To stop them execute
```
$ make stop_services
```
## TODO
* Instance images (`/instances//{preview,image-uint8,image-uint16}`)
* Split/merge studies (`/studies//{split,merge}`)
* Tools API (`/tools`)
* Log API (`/changes`, `/exports`)
* Asynchronous requests (`/jobs`)