Skip to main content

A Python wrapper for the kerefcord API

Project description

# kerefcord.py

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.

Future Of kerefcord

Kerefcord is a new Python library/lib simular to discord.py kerefcord.py is made by Keref

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 kerefcord.py

# Windows
py -3 -m pip install -U kerefcord.py

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

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

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

To install the development version, do the following:

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

class MyClient(discrap.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 kerefcord
from kerefcord.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

kerefcord-3.0a3.tar.gz (338.7 kB view details)

Uploaded Source

File details

Details for the file kerefcord-3.0a3.tar.gz.

File metadata

  • Download URL: kerefcord-3.0a3.tar.gz
  • Upload date:
  • Size: 338.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.2

File hashes

Hashes for kerefcord-3.0a3.tar.gz
Algorithm Hash digest
SHA256 e791343e10f0e532990593eae46bfc91f243b32c7511a6646424150c001b1f0e
MD5 f8d51651cb41b510f8582900f9352d2f
BLAKE2b-256 3c8d7807a85208554ea99d6317d7d4133f595779f5e24593eb88946fbaecf721

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