Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextcord/nextcord
A Python wrapper for the Discord API forked from discord.py
https://github.com/nextcord/nextcord
api-wrapper bot-framework bots discord discord-api discord-bot discord-py discordbot discordpy discordpy-rewrite hacktoberfest python python3
Last synced: 3 days ago
JSON representation
A Python wrapper for the Discord API forked from discord.py
- Host: GitHub
- URL: https://github.com/nextcord/nextcord
- Owner: nextcord
- License: mit
- Created: 2021-08-28T13:02:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T05:31:00.000Z (17 days ago)
- Last Synced: 2024-11-25T16:08:39.809Z (17 days ago)
- Topics: api-wrapper, bot-framework, bots, discord, discord-api, discord-bot, discord-py, discordbot, discordpy, discordpy-rewrite, hacktoberfest, python, python3
- Language: Python
- Homepage: https://docs.nextcord.dev
- Size: 20.2 MB
- Stars: 1,193
- Watchers: 13
- Forks: 192
- Open Issues: 83
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- discord-api-libs - nextcord - A Python wrapper for the Discord API forked from discord.py (Libraries / Python)
- awesome-discordpy - nextcord - A Python wrapper for the Discord API forked from discord.py. (Forks and Wrappers / Miscellaneous)
- awesome-discord - nextcord
- awesome-discord - nextcord - Python (💻 API Libraries)
- awesome-discord-bot-tools - Nextcord - A Python wrapper for the Discord API forked from discord.py (Libraries / Python)
- awesome-discord-bot-tools - Nextcord - A Python wrapper for the Discord API forked from discord.py (Libraries / Python)
README
.. image:: https://raw.githubusercontent.com/nextcord/nextcord/master/assets/repo-banner.svg
:alt: Nextcord
.. image:: https://img.shields.io/discord/881118111967883295?color=blue&label=discord
:target: https://discord.gg/nextcord
:alt: Discord server invite
.. image:: https://img.shields.io/pypi/v/nextcord.svg
:target: https://pypi.org/project/nextcord/
:alt: PyPI version info
.. image:: https://img.shields.io/pypi/dm/nextcord?color=informational&label=pypi%20downloads
:target: https://pypi.org/project/nextcord/
:alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/nextcord.svg
:target: https://pypi.org/project/nextcord/
:alt: PyPI supported Python versions
.. image:: https://img.shields.io/readthedocs/nextcord
:target: https://docs.nextcord.dev/
:alt: Nextcord documentation
Nextcord
--------
A modern, easy-to-use, feature-rich, and async-ready API wrapper for Discord written in Python.
Key Features
-------------
- Modern Pythonic API using ``async`` and ``await``
- Proper rate limit handling
- Optimised in both speed and memory
Installing
----------
**Python 3.8 or higher is required**
To install the library without full voice support, you can just run the following command:
.. code:: sh
# Linux/macOS
python3 -m pip install -U nextcord
# Windows
py -3 -m pip install -U nextcord
Otherwise to get voice support you should run the following command:
.. code:: sh
# Linux/macOS
python3 -m pip install -U "nextcord[voice]"
# Windows
py -3 -m pip install -U nextcord[voice]
To install additional packages for speedup, run the following command:
.. code:: sh
# Linux/macOS
python3 -m pip install -U "nextcord[speed]"
# Windows
py -3 -m pip install -U nextcord[speed]
To install the development version, do the following:
.. code:: sh
$ git clone https://github.com/nextcord/nextcord/
$ cd nextcord
$ python3 -m pip install -U .[voice]
Optional Packages
~~~~~~~~~~~~~~~~~~
* `PyNaCl `__ (for voice support)
* `aiodns `__, `Brotli `__, `cchardet `__ (for aiohttp speedup)
* `orjson `__ (for json speedup)
Please note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. ``apt``, ``dnf``, etc) before running the above commands:
* libffi-dev (or ``libffi-devel`` on some systems)
* python-dev (e.g. ``python3.8-dev`` for Python 3.8)
Quick Example
~~~~~~~~~~~~~
.. code:: py
import nextcord
from nextcord.ext import commands
bot = commands.Bot()
@bot.slash_command(description="Replies with pong!")
async def ping(interaction: nextcord.Interaction):
await interaction.send("Pong!", ephemeral=True)
bot.run("token")
You can find more examples in the `examples directory `_.
**NOTE:** It is not advised to leave your token directly in your code, as it allows anyone with it to access your bot. If you intend to make your code public you should `store it securely `_.
Links
------
- `Documentation `_
- `Official Discord Server `_
- `Discord Developers Server `_