chris-plugin 0.4.0

ChRIS plugin helper

Python ChRIS Plugin Support

ChRIS is a platform for scientific and medical applications. https://chrisproject.org/

This repository provides chris_plugin, a Python utility library for writing programs in Python which can run on ChRIS.

Getting Started

Have an existing Python program? See HOW TO: Convert an existing Python app into a ChRIS ds plugin.

If you're creating a new program, you can start from this template: https://github.com/FNNDSC/python-chrisapp-template

Examples can be found in ./examples.

Usage

After developing a plugin, use the command chris_plugin_info to produce a JSON description of your ChRIS plugin.

chris_plugin_info --dock-image {registry}/{repo}/{name}:{version} [module_name]

If module_name is not given, then chris_plugin_info will automatically discover your ChRIS plugin.

Development Goals

chris_plugin strives to have zero-dependencies and compatible with Python 3.8 through 3.12.