pyOsirix
Table of contents
PyOsirix and gRPC
This provides a Pythonic interface that uses the osirixgRPC plugin to interact with OsiriX and Horos, to provide access to functionality through the gRPC protocol. This will supercede the previous implementation of pyOsiriX as it will be general, and easy to maintain.
- Free software: BSD license
- Documentation: https://osirixgrpc.github.io/
Installation
Requirements
- Python 3+ (https://www.python.org/)
- Horos/Osirix (https://horosproject.org/)
Instructions
Using pip:
pip install pyosirix
Using it from github for development purposes:
git clone git@github.com:osirixgrpc/pyosirix.git
cd pyosirix
pip install -r requirements.txt
# Create your own scripts with main function to test the functionality, note that you need to start an OsirixService first and have Horos/Osirix open.
# See unit tests for examples
Features
- TODO
Development
Want to contribute? Great! We always welcome contributions from interested developers.
To fix a bug or enhance an existing module, follow these steps:
- Fork the repo
- Create a new branch (
git checkout -b improve-feature) - Make the appropriate changes in the files
- Add changes to reflect the changes made
- Commit your changes (
git commit -am 'Improve feature') - Push to the branch (
git push origin improve-feature) - Create a Pull Request
Bug / Feature Request
If you find a bug (the website couldn't handle the query and / or gave undesired results), kindly open an issue here by including your search query and the expected result.
If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.
To-do
- Placeholder
Credits
- Timothy Sum Hon Mun <timothy22000@gmail.com/ timothy.sumhonmun@icr.ac.uk>
- Matthew Blackledge <mattyblackledge@gmail.com/ matthew.blackledge@icr.ac.uk>
