cpr-py

This is the python client for the Cloud Progress rest API. Cloud Progress is a hosted developer tool that provides progress bars with ETA for structured tasks.

The swagger / openapi spec for this api is hosted as a browseable redoc page and in our API repo https://github.com/cloudprogress/cpr-api. The API repo has links to clients in other languages.

This package targets python 3.7+ to get dataclass support -- if your app targets an older version, post a github issue and we'll make it happen.

Installation

pip install cloudprogress
# or if you like to live on the edge:
pip install https://github.com/cloudprogress/cpr-py/archive/master.zip

Example

Check out pizza.py in this repo 🍕 (it's even runnable).

Ops concerns

This is a beta release and it may not be full-featured or reliable. In particular, watch out for:

Timeouts

This is using default requests timeouts. If the cloudprogress.io backend becomes slow or unreliable, your program could hang.

Error handling

In this release, the client errs on the side of clarity and crashes instantly if the server fails. Future releases will provide retry & ignore-error configuration flags.