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 disfork

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

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

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

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

To install the development version, do the following:

$ git clone https://github.com/disfork/disfork
$ cd disfork
$ 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 disfork

class MyClient(disfork.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 disfork.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

disfork-2.0.0a0.tar.gz (825.5 kB view details)

Uploaded Source

File details

Details for the file disfork-2.0.0a0.tar.gz.

File metadata

  • Download URL: disfork-2.0.0a0.tar.gz
  • Upload date:
  • Size: 825.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for disfork-2.0.0a0.tar.gz
Algorithm Hash digest
SHA256 f7169ddf9221848cbe5931f3136c7a7eb5c8aaf323276245cea8d6346e406ab3
MD5 bac596896906306fbcb0ad174e4cf9a9
BLAKE2b-256 2c0096865002605532255b918d76cbca44b3feec42dcaac8b39ef99e8ae82aed

See more details on using hashes here.

Supported by

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