Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request:Docs: Document API Best Practices #557

Open
arky opened this issue Jun 11, 2024 · 1 comment
Open

Feature request:Docs: Document API Best Practices #557

arky opened this issue Jun 11, 2024 · 1 comment
Labels
docs Documentation-related issues

Comments

@arky
Copy link

arky commented Jun 11, 2024

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 #201

Workarounds

Is there an existing workaround to accomplish this?

@arky arky added the enhancement New feature or request label Jun 11, 2024
@JWCook JWCook added docs Documentation-related issues and removed enhancement New feature or request labels Jun 12, 2024
@JWCook
Copy link
Member

JWCook commented Jun 12, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues
Projects
None yet
Development

No branches or pull requests

2 participants