Feature search_rect via API

tomasbedrich / pycaching

A Python 3 interface for working with Geocaching.com website.

https://pycaching.readthedocs.io/

GNU Lesser General Public License v3.0

61 stars 46 forks source link

Feature search_rect via API #151

Closed pkubiak closed 4 years ago

pkubiak commented 4 years ago

I have implemented new method Geocaching.search_rect, which allow to search for caches in given Rectangle. It use new groundspeak API, the same as https://www.geocaching.com/play/map/. Discussed in: https://github.com/tomasbedrich/pycaching/issues/75

Technical details:

It requires login
Method request caches in parts (by default 50 caches per query) in lazy way.
During my experiment I was able to download 8600 cached in 3:40 min.
There is an API rate limit (hit after requesting ~2000caches) signaled with 429 Too many requests HTTP error. Now it is handled with new TooManyRequests exception type and appropriate wait time before continuing.
Method return PM caches for BM, but without location information.
Information about total number of caches in requests area is available, but not exposed via method.

coveralls commented 4 years ago

Coverage increased (+0.08%) to 94.934% when pulling 52cdbdbd6743918891f30acccdc99b93f33f07da on pkubiak:feature-search-rect-via-api into c21ff39005a2b2d9dda2cafc0dc585deba60caed on tomasbedrich:master.

tomasbedrich commented 4 years ago

Approved from my point of view. ✅ Let's just wait also for @FriedrichFroebel.

Do you want me to solve the docs, cleanup and integration as mentioned above? Or do you want to finish it yourself?

pkubiak commented 4 years ago

Approved from my point of view. Let's just wait also for @FriedrichFroebel.

Do you want me to solve the docs, cleanup and integration as mentioned above? Or do you want to finish it yourself?

Thank you, for the review :) There is still one travis issue in python3.5, but I will try to fix it today.

If it is not a problem for you, I would be grateful for solving docs, cleanup and integration :)

FriedrichFroebel commented 4 years ago

I have two minor comments, after this (and preferably fixing the failing test) it should be okay.

pkubiak commented 4 years ago

LGTM. Thanks for your patience.

Thank you for the review :) Sorry for my English :P

tomasbedrich commented 4 years ago

Sorry guys, my priorities are currently elsewhere... As the situation is unlikely to change from my side and I don't want to block this anymore, I have released 4.2.0 and we can solve the docs and cleanup later.