164 lines
5.7 KiB
Plaintext
164 lines
5.7 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: disnake
|
|
Version: 2.9.0
|
|
Summary: A Python wrapper for the Discord API
|
|
Author: Disnake Development
|
|
License: MIT
|
|
Project-URL: Changelog, https://docs.disnake.dev/page/whats_new.html
|
|
Project-URL: Documentation, https://docs.disnake.dev/
|
|
Project-URL: Repository, https://github.com/DisnakeDev/disnake
|
|
Keywords: disnake,discord,discord api
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Natural Language :: English
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Topic :: Internet
|
|
Classifier: Topic :: Software Development :: Libraries
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Classifier: Topic :: Utilities
|
|
Classifier: Typing :: Typed
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/markdown
|
|
License-File: LICENSE
|
|
Requires-Dist: aiohttp (<4.0,>=3.7.0)
|
|
Provides-Extra: discord
|
|
Requires-Dist: discord-disnake ; extra == 'discord'
|
|
Provides-Extra: docs
|
|
Requires-Dist: sphinx (==7.0.1) ; extra == 'docs'
|
|
Requires-Dist: sphinxcontrib-trio (~=1.1.2) ; extra == 'docs'
|
|
Requires-Dist: sphinx-hoverxref (==1.3.0) ; extra == 'docs'
|
|
Requires-Dist: sphinx-autobuild (~=2021.3) ; extra == 'docs'
|
|
Requires-Dist: sphinxcontrib-towncrier (==0.3.2a0) ; extra == 'docs'
|
|
Requires-Dist: towncrier (==23.6.0) ; extra == 'docs'
|
|
Requires-Dist: sphinx-notfound-page (==0.8.3) ; extra == 'docs'
|
|
Provides-Extra: speed
|
|
Requires-Dist: orjson (~=3.6) ; extra == 'speed'
|
|
Requires-Dist: aiodns (>=1.1) ; extra == 'speed'
|
|
Requires-Dist: Brotli ; extra == 'speed'
|
|
Requires-Dist: cchardet ; (python_version < "3.10") and extra == 'speed'
|
|
Provides-Extra: voice
|
|
Requires-Dist: PyNaCl (<1.6,>=1.3.0) ; extra == 'voice'
|
|
|
|
<!-- SPDX-License-Identifier: MIT -->
|
|
|
|
[](https://disnake.dev/)
|
|
|
|
disnake
|
|
=======
|
|
<p align="center">
|
|
<img src="https://img.shields.io/github/actions/workflow/status/DisnakeDev/disnake/lint-test.yml?branch=master&style=flat-square"></img>
|
|
<a href="https://discord.gg/disnake"><img src="https://img.shields.io/discord/808030843078836254?style=flat-square&color=5865f2&logo=discord&logoColor=ffffff&label=discord" alt="Discord server invite" /></a>
|
|
<a href="https://pypi.org/project/disnake/"><img src="https://img.shields.io/pypi/v/disnake.svg?style=flat-square" alt="PyPI version info" /></a>
|
|
<a href="https://pypi.org/project/disnake/"><img src="https://img.shields.io/pypi/pyversions/disnake.svg?style=flat-square" alt="PyPI supported Python versions" /></a>
|
|
<a href="https://github.com/DisnakeDev/disnake/commits"><img src="https://img.shields.io/github/commit-activity/w/DisnakeDev/disnake.svg?style=flat-square" alt="Commit activity" /></a>
|
|
</p>
|
|
|
|
A modern, easy to use, feature-rich, and async-ready API wrapper for Discord written in Python.
|
|
|
|
Key Features
|
|
------------
|
|
|
|
- Proper rate limit handling.
|
|
- Type-safety measures.
|
|
- [FastAPI](https://fastapi.tiangolo.com/)-like slash command syntax.
|
|
|
|
<sup>The syntax and structure of `discord.py 2.0` is preserved.</sup>
|
|
|
|
Installing
|
|
----------
|
|
|
|
**Python 3.8 or higher is required.**
|
|
|
|
To install the library without full voice support, you can just run the
|
|
following command:
|
|
|
|
``` sh
|
|
# Linux/macOS
|
|
python3 -m pip install -U disnake
|
|
|
|
# Windows
|
|
py -3 -m pip install -U disnake
|
|
```
|
|
|
|
Installing `disnake` with full voice support requires you to replace `disnake` here, with `disnake[voice]`. To learn more about voice support (or installing the development version), please visit [this section of our guide](https://guide.disnake.dev/prerequisites/installing-disnake/).
|
|
|
|
(You can optionally install [PyNaCl](https://pypi.org/project/PyNaCl/) for voice support.)
|
|
|
|
Note that voice support on Linux requires installation of `libffi-dev` and `python-dev` packages, via your preferred package manager (e.g. `apt`, `dnf`, etc.) before running the following commands.
|
|
|
|
Versioning
|
|
----------
|
|
|
|
This project does **not** quite follow semantic versioning; for more details, see [version guarantees](https://docs.disnake.dev/en/latest/version_guarantees.html).
|
|
|
|
To be on the safe side and avoid unexpected breaking changes, pin the dependency to a minor version (e.g. `disnake==a.b.*` or `disnake~=a.b.c`) or an exact version (e.g. `disnake==a.b.c`).
|
|
|
|
Quick Example
|
|
-------------
|
|
|
|
### Slash Commands Example
|
|
|
|
``` py
|
|
import disnake
|
|
from disnake.ext import commands
|
|
|
|
bot = commands.InteractionBot(test_guilds=[12345])
|
|
|
|
@bot.slash_command()
|
|
async def ping(inter):
|
|
await inter.response.send_message("Pong!")
|
|
|
|
bot.run("BOT_TOKEN")
|
|
```
|
|
|
|
### Context Menus Example
|
|
|
|
``` py
|
|
import disnake
|
|
from disnake.ext import commands
|
|
|
|
bot = commands.InteractionBot(test_guilds=[12345])
|
|
|
|
@bot.user_command()
|
|
async def avatar(inter, user):
|
|
embed = disnake.Embed(title=str(user))
|
|
embed.set_image(url=user.display_avatar.url)
|
|
await inter.response.send_message(embed=embed)
|
|
|
|
bot.run("BOT_TOKEN")
|
|
```
|
|
|
|
### Prefix Commands Example
|
|
|
|
``` py
|
|
import disnake
|
|
from disnake.ext import commands
|
|
|
|
bot = commands.Bot(command_prefix=commands.when_mentioned)
|
|
|
|
@bot.command()
|
|
async def ping(ctx):
|
|
await ctx.send("Pong!")
|
|
|
|
bot.run("BOT_TOKEN")
|
|
```
|
|
|
|
You can find more examples in the [examples directory](./examples).
|
|
|
|
<br>
|
|
<p align="center">
|
|
<a href="https://docs.disnake.dev/">Documentation</a>
|
|
⁕
|
|
<a href="https://guide.disnake.dev/">Guide</a>
|
|
⁕
|
|
<a href="https://discord.gg/disnake">Discord Server</a>
|
|
⁕
|
|
<a href="https://discord.gg/discord-developers">Discord Developers</a>
|
|
</p>
|
|
<br>
|