client.py README.md needs additional info

RESOLVED FIXED

Status

Taskcluster
Client Libraries
RESOLVED FIXED
2 years ago
2 years ago

People

(Reporter: dustin, Unassigned)

Tracking

Details

The python client readme used to have docs for createTemporaryCredentials and other utility functions.  I think it also had a nice list of the options you could pass to a Client constructor.  That all seems to be gone now.  Did it just get missed in the async overhaul?
Flags: needinfo?(aki)

Comment 1

2 years ago
I still see https://github.com/taskcluster/taskcluster-client.py/blob/master/README.md .
Do you mean in the pypi package, or ...?
Flags: needinfo?(aki)

Comment 2

2 years ago
I haven't found a README\* in 0.0.32, 0.2.0, 0.2.1, or 0.3.0, so it's not a recent disappearance from pypi, if that's what you mean.
Yes, I was talking about README.md.

Looking back in the git history, it appears that none of this was ever present in the README.  I may have been remembering the JS client instead.

So I think we need docs for

 * createTemporaryCredentials
 * createApiClient (and all Clients in general)
Summary: README info about temporary credentials, etc. is gone → client.py README.md needs additional info

Comment 4

2 years ago
https://github.com/escapewindow/taskcluster-client.py/commit/5fe36e348155366fc75ff24f1566714fbbd5bb8d for temporary credentials?

createApiClient is no longer needed with statically generated code, but sure, we can doc it.
Awesome, thanks!
Status: NEW → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → FIXED
Oh, maybe not merged yet.. consider this r+ :)
Status: RESOLVED → REOPENED
Resolution: FIXED → ---

Comment 8

2 years ago
merged & released.
Status: REOPENED → RESOLVED
Last Resolved: 2 years ago2 years ago
Resolution: --- → FIXED
See Also: → bug 1268949
You need to log in before you can comment on or make changes to this bug.