Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Needs introductory documentation and API reference. #9

Open
buchanae opened this issue Aug 11, 2017 · 2 comments · Fixed by #49
Open

Needs introductory documentation and API reference. #9

buchanae opened this issue Aug 11, 2017 · 2 comments · Fixed by #49
Assignees
Milestone

Comments

@buchanae
Copy link

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

@buchanae
Copy link
Author

buchanae commented Oct 31, 2017

# 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
Copy link
Collaborator

uniqueg commented Feb 9, 2023

@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.

@kellrott kellrott added this to the 0.5.0 milestone Feb 10, 2023
@uniqueg uniqueg linked a pull request Feb 11, 2023 that will close this issue
@uniqueg uniqueg self-assigned this Feb 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants