You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

76 lines
2.0 KiB

Welcome to discord.py-self
===========================
.. image:: /images/snake.svg
.. image:: /images/snake_dark.svg
discord.py-self is a modern, easy to use, feature-rich, and async ready API wrapper
for the Discord 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
- Optimised for both speed and memory
- Prevents detection of user account automation
Getting started
-----------------
Is this your first time using the library? This is the place to get started!
- **Migrating from discord.py:** :doc:`migrating_from_dpy`
- **First steps:** :doc:`intro` | :doc:`quickstart` | :doc:`logging`
- **Working with Discord:** :doc:`authenticating` | :doc:`guild_subscriptions`
- **Examples:** Many examples are available in the :resource:`repository <examples>`
| **Obligatory note:**
| Automating user accounts is against the Discord ToS. If what you are trying to do is accomplishable with a bot account, please use one.
Getting help
--------------
If you're having trouble with something, these resources might help.
- Try the :doc:`faq` first, it's got answers to all common questions.
- If you're looking for something specific, try the :ref:`index <genindex>` or :ref:`searching <search>`.
- Report bugs in the :resource:`issue tracker <issues>`.
- Ask in our :resource:`GitHub discussions page <discussions>`.
Extensions
------------
These extensions help you during development when it comes to common tasks.
.. toctree::
:maxdepth: 1
ext/commands/index.rst
ext/tasks/index.rst
Manuals
---------
These pages go into great detail about everything the API can do.
.. toctree::
:maxdepth: 1
api
discord.ext.commands API Reference <ext/commands/api.rst>
discord.ext.tasks API Reference <ext/tasks/index.rst>
Meta
------
If you're looking for something related to the project itself, it's here.
.. toctree::
:maxdepth: 1
whats_new
version_guarantees
migrating_from_dpy
migrating