trustcafe-api-wrapper/README.md
2026-03-31 12:00:49 +01:00

25 lines
No EOL
736 B
Markdown

# Trustcafe API Wrapper
Intended use (not working yet but testing.py does)
```python
import trustcafeapiwrapper, os
API = trustcafeapiwrapper.APIClient(
client_id=os.getenv("client_id"),
client_secret=os.getenv("client_secret")
)
profile = API.run_job('userprofile.get', "simon-little")
```
## Debates
1. Not sure about the name `jobs` and `run_job`. Requests is an
existing package dependency though. `tasks` seems to broard. I'm sure
there's probably an already existing name that I can't articulate how
to find.
2. Should these `job` be called with dot notation? Or with slashes? Or
something else? Is it okay to have these as strings?
3. Should we do validation in the `jobs` or let the server do that all?