Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 2.2 KB

README.md

File metadata and controls

60 lines (44 loc) · 2.2 KB
Raw

disnake-ext-plugins

An extension for disnake that serves as a robust replacement for cogs. No more pointless inheritance, no more singleton classes serving as little more than a namespace, and no more unexpected behaviour when you get anywhere near the inner workings of your extensions.

Key Features

  • Smoothly integrates with disnake,
  • Manage your extensions without inheritance,
  • Minimum boilerplate, maximum control.

Installing

Python 3.8 or higher is required

To install the extension, run the following command in your command prompt/shell:

# Linux/macOS
python3 -m pip install -U git+https://github.com/DisnakeCommunity/disnake-ext-plugins

# Windows
py -3 -m pip install -U git+https://github.com/DisnakeCommunity/disnake-ext-plugins

It will be installed to your existing disnake installation as an extension. From there, it can be imported as:

import disnake_plugins

Example

import disnake
import disnake_plugins


plugin = disnake_plugins.Plugin()


@plugin.slash_command()
async def my_command(inter: disnake.CommandInteraction):
    await inter.response.send_message("Woo!")


setup, teardown = plugin.create_extension_handlers()

Further examples can be found in the examples directory.

Why not disnake.ext.plugins?

Registering into the disnake.ext namespace brings with it a variety of issues, starting with being unable to properly make editable installs into .../site-packages/disnake/ext/. It also leads to inconsistencies with Sphinx autodoc & co., which are simply annoying to work around. This extension used to be part of the disnake.ext namespace, and there used to be a symlink script to get around the editable install limitation. However, we ultimately decided staying in the disnake.ext namespace for its "legacy" wasn't worth the headaches.

Contributing

Any contributions are welcome, feel free to open an issue or submit a pull request if you'd like to see something added. Contribution guidelines will come soon.