Skip to main content

ChRIS client library

Project description

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

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

caw-0.8.0.tar.gz (12.5 kB view hashes)

Uploaded Source

Built Distribution

caw-0.8.0-py3-none-any.whl (16.7 kB view hashes)

Uploaded Python 3

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