Welcome to stoat.py

stoat.py is a modern, easy to use, feature-rich, and async ready API wrapper for the Stoat bot and user APIs.

Features:

• Modern Pythonic API using async/await syntax

• Sane rate limit handling that prevents 429s

• Command extension to aid with bot creation

• Easy to use with an object oriented design

• Optimized for both speed and memory

• Flexible

Getting Started

Is this your first time using the library? This is the place to get started!

• First steps: Introduction | Quickstart | Setting Up Logging

• Working with Stoat: Tokens | Creating a Bot Account | Server Subscriptions

• Examples: Many examples are available in the repository

Getting help

If you’re having trouble with something, these resources might help.

• Try the Frequently Asked Questions first, it’s got answers to all common questions.

• Ask us and hang out with us in our Stoat server.

• If you’re looking for something specific, try the index or searching.

• Report bugs in the issue tracker.

• Ask in our GitHub discussions page.

Extensions

These extensions help you during development when it comes to common tasks.

• stoat.ext.chunking – An extension for member chunking
• stoat.ext.commands – Bot commands framework

Manuals

These pages go into great detail about everything the API can do.

• API reference
• stoat.ext.chunking API reference
• stoat.ext.commands API reference