dbdk 1.0.1

Discord Bot Dev Kit is a set of funtions and classes to simplify the creation of discord bots

NoVa - Discord Bot Dev Kit

Is a set of funtions and classes to simplify the creation of discord bots

Installing DBDK

pip install dbdk

• You can install DBDK manually using PyPI

Importing DBDK

from dbdk import * 

Note: check Imports and Defined members to know what's being imported

Creating A Root

@bot.command(name="sample")
async def sample_command(ctx: commands.context.Context):

    root: Root = await create_root(ctx)

• Roots are the start and managers of everything in DBDK. In most cases you will only need 1 root per command.

View Introduction

• As shown in the example above, we assuming this is inside a command function definition.

root: Root = await create_root(ctx)

# by default `root` has a `view` property
root.view

# You can add items to the view using `add_items` method
await root.view.add_items(
    Button(on_click_callback, "This is the label"),

    SelectMenu(
        on_select_callback, options = [
            SelectOption
        ]
    )
)

• add_items method update the root, so changes will be displayed when called

• Check Pycord API reference: discord.ui.View for more details.

Adding a Button to the view

# Create a on click callback function; this function is called when the button is clicked
async def on_click(clicked_button: Button, interaction: discord.Interaction):

    # respond the interacion
    await interaction.response.send_message("You Clicked the button!")

await root.view.add_items(
    Button(
        on_click,
        label = "Click Me!",
        emoji = '🙂'
    )
)

    # That's all, you'll see changes reflected in the root message

• Check Pycord API reference: discord.Button for more details.

Embeds

await root.embeds.add_items(
    Embed(
        title = "My Embed",
        description = "My embed description :D",
        color = discord.Color.green()
    )
)

• Check Pycord API reference: discord.Embed for more details.

Imports And Defined Members

• This may vary a lot.

0. Any = typing.Any

1. Await = typing.Await

2. Awaitable = typing.Awaitable

3. Bot = discord.ext.commands.Bot

4. Button = discord.ui.Button

5. ButtonStyle = discord.ButtonSyle

6. Callable = typing.Calleable

7. Colour = discord.Colour

8. Component = discord.Component

9. Dict = typing.Dict

10. Embed = discord.Embed

11. EmbedField = discord.EmbedField

12. EmbedList = dbdk.embed.EmbedList

13. EmbedTemplate = dbdk.embed.EmbedTemplate

14. Emoji = discord.Emoji

15. ExceptionList = dbdk.utils.ExceptionList

16. InputText = discord.ui.InputText

17. InputTextStyle = discord.InputTextStyle (Shortcut)

18. InputTextType = discord.InputTextStyle (Shortcut)

19. List = typing.List

20. Modal = dbdk.modal.Modal

21. OptionType = ?

22. Root = dbdk.root.Root

23. RootItems = dbdk.root.RootItems

24. SelectMenu = dbdk.components.SelectMenu

25. SelectOption = dbdk.components.SelectOption

26. States = dbdk.utils.States (Concept class)

27. Tuple = typing.Tuple

28. Union = typing.Union

29. View = dbdk.view.View

30. commands = discord.ext.commands

31. components = dbdk.components (Module)

32. create_root = dbdk.kit.create_root

33. datetime = datetime (Module)

34. default_on_select = dbdk.components.default_on_select

35. default_on_submit = dbdk.modal.default_on_submit

36. default_on_timeout = dbdk.view.default_on_timeout

37. discord = discord (Module)

38. embed = dbdk.embed (Module)

39. extract = dbdk.utils.extract

40. modal = dbdk.modal (Module)

41. namedtuple = collections.namedtuple

42. root = dbdk.root (Module)

43. types = dbdk.types (Module)

44. ui = discord.ui (Shortcut)

45. utils = dbdk.utils (Module)

46. view = dbdk.view (Module)