pyinaturalist icon indicating copy to clipboard operation
pyinaturalist copied to clipboard

Feature request:Docs: Document API Best Practices

Open arky opened this issue 1 year ago • 1 comments

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?

arky avatar Jun 11 '24 07:06 arky

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.

JWCook avatar Jun 12 '24 16:06 JWCook