cordslite 🍺

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/AnswerDotAI/cordslite.git

or from pypi

$ pip install cordslite

How to use

Setup

Getting a bot token:

1. Go to the Discord Developer Portal.
2. Create an application, then add a bot under “Bot”.
3. Copy the token and set it as an environment variable:

export DISCORD_BOT_TOKEN='your_token_here'

4. Under “OAuth2”, generate an invite URL with the bot scope and the permissions you need, and open it to invite the bot to your server.

Then create the client:

from cordslite import *

dc = DiscordClient()

Guilds and Channels

Fetch a guild (server) and explore its channels:

gid = '1493461895615873044'
gld = await dc.guild(gid)
gld

Guild(id=1493461895615873044, name='AAI-test-dev')

chs = await gld.channels()
chs

Messages

Fetch recent messages from a channel and send one:

ch = chs[2]
msgs = await ch.messages(5)
msgs

msg = await ch.send('Hello from cordslite! 🍺')
msg

Message(id=1545128287922159727, author='share2self', content='Hello from cordslite! 🍺')

Gateway (Real-time Events)

Connect, then register handlers for events such as MESSAGE_CREATE:

intents = Intent.GUILDS | Intent.GUILD_VOICE_STATES | Intent.GUILD_MESSAGES | Intent.MESSAGE_CONTENT
gc = GatewayClient(intents, dc)
await gc.start()

async def on_msg(msg): print(f"{msg.author['username']}: {msg.content}")

gc.on('MESSAGE_CREATE', on_msg)

msg = await ch.send('Watch this ma!')
msg

Message(id=1545128289734107176, author='share2self', content='Watch this ma!')

await gc.stop()

Bot

Bot ties REST and Gateway together with a decorator-based command router. It lives in cordslite.bot, alongside the voice support, and needs the voice extra: pip install cordslite[voice]. The function name becomes the command name, prefixed with ! in Discord:

from cordslite.bot import *

bot = Bot(intents)
await bot.start()

@bot.cmd
async def echo(msg, args): await (await msg.channel).send(f'You said: {args}')

bot

Bot(cmds=['echo'])

The router catches errors in command handlers and stores them in bot.errors. You can also register a handler that runs as they happen:

@bot.on_error
async def handle_err(msg, e): print(f'Error: {e}')

import asyncio

Voice

Join a voice channel, record audio, and leave:

vch = next(c for c in await gld.channels() if c.type == 2)
vc = await bot.join_voice(vch)
await asyncio.wait_for(vc.sess.wait(), 15)
vc.start_recording(path='/tmp/recording.mp3')

voice json 15 {'any': 100}

'/tmp/recording.mp3'

await asyncio.sleep(5)
res = await vc.stop_recording()
await bot.leave_voice()
await bot.stop()
res

{'speakers': {}, 'mixed': None}

from IPython.display import Audio

Audio(res['mixed'])