Ep

A different kind of discord bot framework

Index

• Abstract
• Examples
• Installing

Abstract

Ep started out as a wholesome discord bot for the efficient python discord guild but as time passed it grew into a large, wild, not very well maintained code base.

Ep is to the commands extension what django is to flask, just a batteries included approach to making discord bots. This repository is separated out as the library /ep/ and simultainiously a discord bot /default/.

Examples

Ping!

First lets write our cog, here we're creating the file ./cogs/ping.py (create the cogs directory if you haven't already):

# ./cogs/ping.py

from discord import Message
from ep import Cog

__all__ = {"Ping"}

@Cog.export
class Ping(Cog):

    @Cog.regex(r"!ping", message_author_bot=False)
    def action(self, message: Message) -> str:
        await message.channel.send('Pong!')

Now we have to generate a configuration file. We can do this easily with:

• ep -C > ./cogs/foo.ep.toml

Then set the discord token, this is done as an environment variable:

• export DISCORD_TOKEN="YOUR_TOKEN_HERE"

The bot can now be run with:

• ep -c ./cogs/foo.ep.toml

Events

Regular

class RegularStyle(Cog):
    @Cog.event
    async def on_message(self, message: Message) -> None:  # Plain ol' boring events, ugh
        assert isinstanc(message, Message)

Smarter

class NewStyle(Cog):
    @Cog.event(tp="on_message", message_channel_id=SPECIAL_CHANNEL)  # Alright! now we can apply predicates over event dispatch.
    async def filtered_message(self, message: Message) -> None:
        assert message.channel.id == SPECIAL_CHANNEL

Commands

class Commands(Cog):
    @Cog.regex(r'[\.!$]check')
    async def check_trigger(self, message: Message) -> None:
        await message.channel.send("Yes commands work!")  # it's just a regular expression :)

Installing

• pip3 install git+https://github.com/mental32/ep#egg=ep