ohsu-comp-bio / py-tes

Python SDK for the GA4GH Task Execution API
https://py-tes.readthedocs.io/
MIT License
5 stars 9 forks source link

Needs introductory documentation and API reference. #9

Open buchanae opened 7 years ago

buchanae commented 7 years ago

People shouldn't have to dig into the code to learn how to use it.

buchanae commented 6 years ago
# pip install py-tes

import tes

task = tes.Task(
    executors=[
        Executor(
            image_name="alpine",
            cmd=["echo", "hello"]
        )
    ]
)

cli = tes.HTTPClient("http://funnel.example.com", timeout=5)
task_id = cli.create_task(task)
res = cli.get_task(task_id)
cli.cancel_task(task_id)
uniqueg commented 1 year ago

@kellrott: I have extended the usage instructions.

As for the API reference: I could add them for Read the Docs with Sphinx, just like here: https://trs-cli.readthedocs.io/en/latest/ Or perhaps you prefer MkDocs, maybe on GitHub pages? I could try to find a solution there.

Let me know and I'll look into it.