Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.51 KB

README.md

File metadata and controls

53 lines (38 loc) · 1.51 KB
Raw

Python ChRIS Client

PyPI License - MIT CI Code style: black

A Python ChRIS client library.

Installation

pip install -U caw

Example

from pathlib import Path
from chris.client import ChrisClient

client = ChrisClient.from_login(
    address="https://cube.chrisproject.org/api/v1/",
    username="chris",
    password="chris1234"
)
client.upload(Path("example.txt"), "my_examples")
dircopy = client.get_plugin_by_name("pl-dircopy")
plinst = dircopy.create_instance({"dir": "chris/uploads/my_examples/example.txt"})

Async

Looking for an async ChRIS client? Let us know! We have one implemented here, though it's not published to PyPI.

Command-Line Client

chrs is the next-generation ChRIS command-line client, please check it out.

caw previously included a command-line client for ChRIS, however since v0.7.0 it was deprecated and removed.

To use the caw command:

pip install caw==0.6.1

Usage: https://github.com/FNNDSC/caw/blob/d5b05b28af312b97ac80bd96376d70626db737a5/README.md