Skip to main content

A Python wrapper for the discord API

Project description

Discord server invite PyPI version info PyPI supported Python versions

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:

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

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

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

# Linux/macOS
python3 -m pip install -U "dis-py[voice]"

# Windows
py -3 -m pip install -U dis-py[voice]

To install the development version, do the following:

$ git clone https://github.com/GearSolution/dis.py
$ cd dis.py
$ python3 -m pip install -U .[voice]

Optional Packages

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.6-dev for Python 3.6)

Quick Example

import discord

class MyClient(discord.Client):
    async def on_ready(self):
        print('Logged on as', self.user)

    async def on_message(self, message):
        # don't respond to ourselves
        if message.author == self.user:
            return

        if message.content == 'ping':
            await message.channel.send('pong')

client = MyClient()
client.run('token')

Bot Example

import discord
from discord.ext import commands

bot = commands.Bot(command_prefix='>')

@bot.command()
async def ping(ctx):
    await ctx.send('pong')

bot.run('token')

You can find more examples in the examples directory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dis-py-2.0.0a0.tar.gz (815.4 kB view details)

Uploaded Source

File details

Details for the file dis-py-2.0.0a0.tar.gz.

File metadata

  • Download URL: dis-py-2.0.0a0.tar.gz
  • Upload date:
  • Size: 815.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.1

File hashes

Hashes for dis-py-2.0.0a0.tar.gz
Algorithm Hash digest
SHA256 62726c0f0f1ebe25a66689bf8716d496d53312a2199e8d2a29829b456e07ac1b
MD5 9c4aef560684785af5c1deaf72cf1de1
BLAKE2b-256 cf945057c143ddab44bfc591068176a3568fce3a903275b72f28be22cb025b38

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page