kopf/httsleep

A python library for polling HTTP endpoints - batteries included!

httsleep's Issues

Support passing in a `Session` object

Users may already have a requests.Session object and wish to reuse that rather than having httsleep create a blank one. This would save users from re-entering standard headers, settings etc. that they've already configured elsewhere.

Ideal usage afterwards:

    httsleep(url, until=until, alarms=alarms, session=my_session)

~~~Workaround~~~ Not usable

    poller = HttSleeper(url, until=until, alarms=alarms)
    poller.session = my_session
    poller.run()

Not usable because here the request is prepared without the context of the Session:

response = self.session.send(self.request.prepare()

The workaround would be usable if this line was instead:

response = self.session.send(self.session.prepare_request(request))

Improve documentation

Improve documentation such that:

• we begin by defining a simple API and use it for all examples
• the explanation of the conditions is less technical

Support `verify=False` usage as per requests library

It's not currently possible to use httsleep and ignore certificate errors, as you would with requests.get(..., verify=False).

This looks fairly simple to add so I'll try to follow this with a PR and hopefully we can improve things.

How to write condition that polls until field with given value is missing

In my case I create a job and want to poll until that job has completed. There is only one endpoint and it gives me the list of jobs that are in progress. If my job is not on the list - it's completed. Example response body:

[
   {"id": 1}, {"id": 2}, {"id": 3}
]

I want to poll until returned json does not contain my id. Any idea how can I write that condition?

jsonpath-rw should be an optional dependency

Is there any reason why the dependency on jsonpath-rw can't be made optional?

asyncio support

Remove convenience kwargs

Deprecate and remove convenience kwargs (status_code etc), leaving just until and alarms

(hi @MathMagique - I've relented! ;) )

Dict comprehensions don't work in Python 2.6

I know Python 2.6 is quite an old version :)
But dict comprehensions doesn't appear until Python 2.7, so below from main.py Line 81 would fail:

until.append({k: v for k, v in condition.items() if v})

Maybe a simple plain alternative list append is enough.

Add CLI

Add "httsleep from the command line"