search

pyinat / pyinaturalist

Python client for iNaturalist
https://pyinaturalist.readthedocs.io
MIT License
130 stars 17 forks source link

Feature request:Docs: Document API Best Practices #557

Open arky opened 2 months ago

arky commented 2 months ago

Feature description

Please document best practices that are recommend by iNat

Use case

Is there a specific goal that this would help you accomplish, or can you provide any other context about how you would like to use this feature? Document some of the rate limiting features implemented in pyinaturalist and also high warnings of overwhelming the inat server that might result in bans.

Related to https://github.com/pyinat/pyinaturalist/issues/201

Workarounds

Is there an existing workaround to accomplish this?

JWCook commented 2 months ago

Rate limiting is currently documented here, with links to those iNat docs: https://pyinaturalist.readthedocs.io/en/latest/user_guide/advanced.html#rate-limiting

With default settings, pyinaturalist should never exceed those limits, but I can add some more notes there for anyone who wants to modify those settings.