Skip to content

Latest commit

 

History

History
144 lines (98 loc) · 4.37 KB

README.rst

File metadata and controls

144 lines (98 loc) · 4.37 KB
Raw

Pycord

Discord server invite PyPI version info PyPI supported Python versions PyPI downloads Latest release

A fork of discord.py. Pycord is 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 for both speed and memory usage.
  • Full Application Command Support

Installing

Python 3.8 or higher is required

To install the library without full voice support, you can just run the following command:

# Linux/macOS
python3 -m pip install -U py-cord

# Windows
py -3 -m pip install -U py-cord

Otherwise to get voice support you should run the following command:

# 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:

# 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:

$ 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:

# 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

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

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

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 examples in the examples directory.

Note: Make sure you do not reveal your bot token to anyone, it can grant access to your bot.

Useful Links