Skip to main content

Pythonic interface for interacting with Osirix through gRPC protocol

Project description

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.

Installation

Requirements

Instructions

Using pip:

pip install pyosirix

Using it from github for development purposes:

git clone git@github.com:osirixgrpc/pyosirix.git
cd pyosirix
# 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!

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

History

0.1.4 (2021-10-28)

  • Bug Fixes, Tests

0.1.3 (2021-10-27)

  • First release on PyPI.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyosirix-0.2.1.tar.gz (433.9 kB view hashes)

Uploaded source

Built Distribution

pyosirix-0.2.1-py2.py3-none-any.whl (24.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page