Calcbench data is not free and API access is not included in the standard Calcbench subscription. Talk to email@example.com before you start coding.
Installing the Client¶
Install the Calcbench client from pip:
$ pip install calcbench-api-client
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.
Credentials can be stored in the “CALCBENCH_USERNAME” and “CALCBENCH_PASSWORD” environment variables OR set the calcbench_api credentials on your Keychain|Secret Service|Windows Credential Locker
Set Credentials At Runtime¶
Call cb.set_credentials(”firstname.lastname@example.org”, “password”)
On an interactive shell the package will ask for credentials as input
- calcbench.set_credentials(cb_username, cb_password)¶
Set your calcbench credentials.
Call this before any other Calcbench functions.
Alternatively set the
CALCBENCH_PASSWORDenvironment variables OR set the calcbench_api credentials on your Keychain|Secret Service|Windows Credential Locker
cb_username (str) – Your calcbench.com email address
cb_password (str) – Your calcbench.com password
>>> calcbench.set_credentials("email@example.com", "NotMyRealPassword")
- 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.
By default gives up immediately if the server returns 404
bool) – toggle backoff
bool]) – function that handles exception and decides whether to continue or not.
>>> calcbench.enable_backoff(giveup=lambda e: e.response and e.response.status_code == 404)
Set proxies used for requests. See https://requests.readthedocs.io/en/master/user/advanced/#proxies
- calcbench.turn_on_logging(level=10, timezone='US/Eastern')¶
Turn on verbose logging
- Return type: