Skip to main content

ChRIS plugin helper

Project description

Python ChRIS Plugin Support

codecov .github/workflows/test.yml PyPI License - MIT Code style: black

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.

Project details


Download files

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

Source Distribution

chris_plugin-0.4.0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

chris_plugin-0.4.0-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

Details for the file chris_plugin-0.4.0.tar.gz.

File metadata

  • Download URL: chris_plugin-0.4.0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for chris_plugin-0.4.0.tar.gz
Algorithm Hash digest
SHA256 5c5fcadd475cf8c0b462fe83a9013783f0139911ecd43047c72306bf65d70cdf
MD5 db991acbe73e7713194c5f343ec3f2c5
BLAKE2b-256 a8b857f93b6149e418efc2eed6f11632be629e5d657245c751ca10509f726ec9

See more details on using hashes here.

File details

Details for the file chris_plugin-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: chris_plugin-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 22.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for chris_plugin-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 93ab4a373ca5587f6e5434a0dfaa847e11c59385e3d1060abdf161da55f66d4a
MD5 0bb3a0bb2d9e3b428b4cccffd9028c1a
BLAKE2b-256 766059e99f512458b5d5fdbc03ec843441d57093a050f7466986ead2925dcac1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page