A Ruby implementation of the Orthanc DICOM server v0.8.6 REST API
Extremely Alpha!! Not ready for production. Anything may change, including resource nesting and naming schemes.
(This is my first API client gem, experienced help or advice would be most appreciated) :)
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install orthanc
The gem tries to follow the Orthanc API naming scheme as closely as possible, converting methods and response items to snake case to make the experience more ruby-like.
api=Orthanc::Client.new("localhost", "8042") api.all_patients api.all_patients.first api.system.database_version => 5 api.statistics.count_studies => 14
You get the picture.
After checking out the repo, run
bin/setup to install dependencies. Then, run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release to create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
- Fork it ( https://github.com/[my-github-username]/orthanc/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request