snowfin's Introduction

snowfin

An async discord http interactions framework built on top of Sanic.

Installing

Please note that the library requires at least python 3.10

pip install snowfin
#or
poetry add snowfin

Examples

Simple slash command

import asyncio
import snowfin
from snowfin.client import AutoDefer
from snowfin.models import Interaction
from snowfin.response import MessageResponse

bot = snowfin.Client('public_key', 'application_id', 'token', auto_defer=AutoDefer(enabled=True, timeout=0, ephemeral=True))

@snowfin.slash_command(name="hello")
async def hello(context: Interaction):
    # we don't have to do anything, just don't return a response until we need to
    await asyncio.sleep(10)
    return MessageResponse('Ok, *Now* I want to respond ;)')

bot.run("0.0.0.0", 80, debug=True)

Slash command with a deferred response

import asyncio
import snowfin
from snowfin.models import Interaction
from snowfin.response import DeferredResponse, MessageResponse

bot = snowfin.Client('public_key', 'application_id', 'token', auto_defer=True)

@snowfin.slash_command(name="hello")
async def on_slash(context: Interaction):
    return DeferredResponse(on_slash_defer)

async def on_slash_defer(context: Interaction):
    await asyncio.sleep(1)
    return MessageResponse('Ok, *Now* I want to respond ;)')

bot.run("0.0.0.0", 80, debug=True)

You can see more examples here

Contributors

Stargazers

Watchers

snowfin's Issues

Callback loading bug

Since commands and callbacks are on each client, calling the decorators snowfin.slash_command, snowfin.select_callback, etc., does not work as it doesn't load the callbacks into the client. Tested with https://github.com/KAJdev/snowfin/blob/main/examples/deferred_example.py and https://github.com/KAJdev/snowfin/blob/main/examples/component_example.py.

It seems like it requires it to be a Module, and load_module() must be called in order to properly load the callbacks into the client.

Simple non-working example:

import snowfin
from snowfin.models import Interaction
import asyncio

bot = snowfin.Client(...)


@snowfin.slash_command(name="hello")
async def on_slash(context: Interaction):
    return snowfin.DeferredResponse(on_slash_defer)

async def on_slash_defer(context: Interaction):
    await asyncio.sleep(1)
    return snowfin.MessageResponse('Ok, *Now* I want to respond ;)')


bot.run("0.0.0.0", 8000, debug=True, auto_reload=True)

Recommend Projects