Skip to main content

A Python wrapper for the Discord user API

Project description

Telegram chat PyPI version info PyPI supported Python versions PyPI downloads per month

A modern, easy to use, feature-rich, and async ready API wrapper for Discord’s user API written in Python.

Note:
Automating user accounts is against the Discord ToS. This library is a proof of concept and I cannot recommend using it. Do so at your own risk.

Fork Changes

These changes have become too numerous to mention, so check out our docs.

Credits:

  • Rapptz for the original library this fork is based on. Without it, the project would not exist.

  • arandomnewaccount for help when the project was first started.

Key Features

  • Modern Pythonic API using async and await.

  • Proper rate limit handling.

  • Optimised in both speed and memory.

  • Mostly compatible with the upstream discord.py.

  • Prevents user account automation detection.

  • Implements vast amounts of the user account-specific API. For a non-exhaustive list:

    • Sessions

    • Read states

    • Connections

    • Relationships

    • Experiments

    • Protobuf user settings

    • Application/team management

    • Store/SKUs/entitlements

    • Billing (e.g. subscriptions, payments, boosts, promotions, etc.)

    • Interactions (slash commands, buttons, etc.)

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 pycord-self

# Windows
py -3 -m pip install -U pycord-self

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

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

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

To install the development version, do the following:

$ git clone https://github.com/dolfies/pycord-self
$ cd pycord-self
$ 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)

Using with Upstream

If you would like to use the library alongside upstream discord.py, you can install selfcord.py instead of pycord-self. Check out the renamed branch for more information.

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):
        # only 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='>', self_bot=True)

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

bot.run('token')

You can find more examples in the examples directory.

Project details


Release history Release notifications | RSS feed

This version

2.0

Download files

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

Source Distribution

pycord_self-2.0.tar.gz (1.1 MB view details)

Uploaded Source

File details

Details for the file pycord_self-2.0.tar.gz.

File metadata

  • Download URL: pycord_self-2.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for pycord_self-2.0.tar.gz
Algorithm Hash digest
SHA256 6889625d16083b0b52e5236528f92c3820ec0cafe7708ce0b0c6b776061fff5d
MD5 4393bc7b8dfb38b3f292b0765e2657f0
BLAKE2b-256 00940d91b5d236940ea84a53c0f80184b1b530567d1ad1d68ad0f232c368fd48

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