Getting Started¶
Obtain Credentials¶
The API uses the same credentials as calcbench.com. If you do not have Calcbench credentials you can sign up for free two-week trial @ https://www.calcbench.com/join.
Warning
Talk to us before you start coding, Calcbench data is not free.
Set Credentials¶
- calcbench.set_credentials(cb_username, cb_password)¶
Set your calcbench credentials.
Call this before any other Calcbench functions.
Alternatively set the
CALCBENCH_USERNAME
andCALCBENCH_PASSWORD
environment variables- Parameters
cb_username (str) – Your calcbench.com email address
cb_password (str) – Your calcbench.com password
Usage:
>>> calcbench.set_credentials("andrew@calcbench.com", "NotMyRealPassword")
Error Retry¶
- calcbench.enable_backoff(backoff_on=True, giveup=<function <lambda>>)¶
Re-try failed requests with exponential back-off
Requires the backoff package.
pip install backoff
If processes make many requests, failures are inevitable. Call this to retry failed requests.
- Parameters
backoff_on (
bool
) – toggle backoffgiveup (
Callable
[[Exception
],bool
]) – function that handles exception and decides whether to continue or not.
- Usage::
>>> calcbench.enable_backoff(giveup=lambda e: e.response.status_code == 404)
Network Proxy¶
- calcbench.set_proxies(proxies)¶
Set proxies used for requests. See https://requests.readthedocs.io/en/master/user/advanced/#proxies