FNNDSC / aiochris

ChRIS python client built on aiohttp

aiochris

ChRIS Python client library built on aiohttp (async HTTP client) and pyserde (dataclasses deserializer).

Installation

Requires Python 3.10 or 3.11.

pip install aiochris
# or
poetry add aiochris

Quick Example

import asyncio
from aiochris import ChrisClient


async def readme_example():
    chris = await ChrisClient.from_login(
        username='chris',
        password='chris1234',
        url='https://cube.chrisproject.org/api/v1/'
    )
    dircopy = await chris.search_plugins(name_exact='pl-brainmgz', version='2.0.3').get_only()
    plinst = await dircopy.create_instance(compute_resource_name='host')
    feed = await plinst.get_feed()
    await feed.set(name="hello, aiochris!")
    await chris.close()  # do not forget to clean up!


asyncio.run(readme_example())

Documentation Links

• Client documentation: https://fnndsc.github.io/aiochris
• Developer documentation: https://github.com/FNNDSC/aiochris/wiki