Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Pycord-Development/pycord
Pycord, a maintained fork of discord.py, is a python wrapper for the Discord API
https://github.com/Pycord-Development/pycord
discord discord-py hacktoberfest py-cord pycord python
Last synced: 9 days ago
JSON representation
Pycord, a maintained fork of discord.py, is a python wrapper for the Discord API
- Host: GitHub
- URL: https://github.com/Pycord-Development/pycord
- Owner: Pycord-Development
- License: mit
- Created: 2021-08-28T16:18:37.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T21:57:02.000Z (7 months ago)
- Last Synced: 2024-04-14T01:00:10.046Z (7 months ago)
- Topics: discord, discord-py, hacktoberfest, py-cord, pycord, python
- Language: Python
- Homepage: https://docs.pycord.dev
- Size: 15.8 MB
- Stars: 2,632
- Watchers: 31
- Forks: 454
- Open Issues: 76
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-discordpy - pycord - Pycord, a maintained fork of discord.py, is a python wrapper for the Discord API. (Forks and Wrappers / Miscellaneous)
- awesome-discord - pycord
- awesome-discord - pycord - Python (💻 API Libraries)
- discord-api-libs - pycord - Pycord is a modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python (Libraries / Python)
README
.. image:: https://raw.githubusercontent.com/Pycord-Development/pycord/master/pycord.png
:alt: Pycord v3
Pycord is a modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.
======
.. image:: https://img.shields.io/pypi/v/py-cord.svg?style=for-the-badge&logo=pypi&color=yellowgreen&logoColor=white
:target: https://pypi.python.org/pypi/py-cord
:alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/py-cord.svg?style=for-the-badge&logo=python&logoColor=white
:target: https://pypi.python.org/pypi/py-cord
:alt: PyPI supported Python versions
.. image:: https://img.shields.io/pypi/dm/py-cord?color=blueviolet&logo=pypi&logoColor=white&style=for-the-badge
:target: https://pypi.python.org/pypi/py-cord
:alt: PyPI downloads
.. image:: https://img.shields.io/github/v/release/Pycord-Development/pycord?include_prereleases&label=Latest%20Release&logo=github&sort=semver&style=for-the-badge&logoColor=white
:target: https://github.com/Pycord-Development/pycord/releases
:alt: Latest release
.. image:: https://img.shields.io/discord/881207955029110855?label=discord&style=for-the-badge&logo=discord&color=5865F2&logoColor=white
:target: https://pycord.dev/discord
:alt: Discord server invite
.. image:: https://badges.crowdin.net/badge/dark/crowdin-on-light.png
:target: https://translations.pycord.dev/documentation/?utm_source=badge&utm_medium=referral&utm_campaign=badge-add-on
:alt: Crowdin | Agile localization for tech companies
======
Key Features
------------
- Modern Pythonic API using ``async`` and ``await``.
- Proper rate limit handling.
- Optimised for both speed and memory usage.
- Full application API support.
Installing
----------
**Python 3.9 or higher is required**
To install the library without full voice support, run the following command:
.. code:: sh
# Linux/macOS
python3 -m pip install -U py-cord
# Windows
py -3 -m pip install -U py-cord
Otherwise, to get full voice support, run the following command:
.. code:: sh
# Linux/macOS
python3 -m pip install -U "py-cord[voice]"
# Windows
py -3 -m pip install -U py-cord[voice]
To install additional packages for speedup, run the following command:
.. code:: sh
# Linux/macOS
python3 -m pip install -U "py-cord[speed]"
# Windows
py -3 -m pip install -U py-cord[speed]
To install the development version, do the following:
.. code:: sh
$ git clone https://github.com/Pycord-Development/pycord
$ cd pycord
$ python3 -m pip install -U .[voice]
or if you do not want to clone the repository:
.. code:: sh
# Linux/macOS
python3 -m pip install git+https://github.com/Pycord-Development/pycord
# Windows
py -3 -m pip install git+https://github.com/Pycord-Development/pycord
Optional Packages
~~~~~~~~~~~~~~~~~
* `PyNaCl `__ (for voice support)
* `aiodns `__, `brotlipy `__, `cchardet `__ (for aiohttp speedup)
* `msgspec `__ (for json speedup)
Please note that while installing voice support on Linux, you must install the following packages via your preferred 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.10-dev`` for Python 3.10)
Quick Example
-------------
.. code:: py
import discord
bot = discord.Bot()
@bot.slash_command()
async def hello(ctx, name: str = None):
name = name or ctx.author.name
await ctx.respond(f"Hello {name}!")
@bot.user_command(name="Say Hello")
async def hi(ctx, user):
await ctx.respond(f"{ctx.author.mention} says hello to {user.name}!")
bot.run("token")
Traditional Commands Example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: py
import discord
from discord.ext import commands
intents = discord.Intents.default()
intents.message_content = True
bot = commands.Bot(command_prefix=">", intents=intents)
@bot.command()
async def ping(ctx):
await ctx.send("pong")
bot.run("token")
You can find more code examples in the ``examples`` directory.
Note: Make sure you do not reveal your bot token to anyone, as it can grant access to your bot.
Useful Links
------------
- `Documentation `_
- `Learn how to create Discord bots with Pycord `_
- `Our Official Discord Server `_
- `Official Discord Developers Server `_
Translations
------------
.. image:: https://badges.awesome-crowdin.com/translation-200034237-5.png
:alt: Translation Status