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](https://github.com/DisnakeDev/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:
``` sh
# Linux/macOS
python3 -m pip install -U disnake-ext-plugins
# Windows
py -3 -m pip install -U disnake-ext-plugins
```
After installing, disnake-ext-plugins can be imported as
```py
import disnake_plugins
```
Example
-------
```py
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](https://github.com/Chromosomologist/disnake-ext-plugins/tree/master/examples).
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/Chromosomologist/disnake-ext-plugins",
"name": "disnake-ext-plugins",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "disnake, disnake.ext, discord, cogs",
"author": "Chromosomologist",
"author_email": "chromosomologist@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/91/c4/165db95505242c3d59aba16257f065a51a8a411f66fe175516e3db90e319/disnake_ext_plugins-0.3.0.tar.gz",
"platform": null,
"description": "disnake-ext-plugins\n===================\n\nAn extension for disnake that serves as a robust replacement for cogs.\nNo more pointless inheritance, no more singleton classes serving as little more\nthan a namespace, and no more unexpected behaviour when you get anywhere near\nthe inner workings of your extensions.\n\nKey Features\n------------\n- Smoothly integrates with [disnake](https://github.com/DisnakeDev/disnake),\n- Manage your extensions without inheritance,\n- Minimum boilerplate, maximum control.\n\nInstalling\n----------\n**Python 3.8 or higher is required**\n\nTo install the extension, run the following command in your command prompt/shell:\n\n``` sh\n# Linux/macOS\npython3 -m pip install -U disnake-ext-plugins\n\n# Windows\npy -3 -m pip install -U disnake-ext-plugins\n```\n\nAfter installing, disnake-ext-plugins can be imported as\n```py\nimport disnake_plugins\n```\n\nExample\n-------\n```py\nimport disnake\nimport disnake_plugins\n\n\nplugin = disnake_plugins.Plugin()\n\n\n@plugin.slash_command()\nasync def my_command(inter: disnake.CommandInteraction):\n await inter.response.send_message(\"Woo!\")\n\n\nsetup, teardown = plugin.create_extension_handlers()\n```\nFurther examples can be found in [the examples directory](https://github.com/Chromosomologist/disnake-ext-plugins/tree/master/examples).\n\nWhy not disnake.ext.plugins?\n----------------------------\nRegistering 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.\nThis 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.\n\nContributing\n------------\nAny 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.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An extension for disnake providing a robust alternative to cogs.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/Chromosomologist/disnake-ext-plugins",
"Repository": "https://github.com/Chromosomologist/disnake-ext-plugins"
},
"split_keywords": [
"disnake",
" disnake.ext",
" discord",
" cogs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66c0b0d7a8e7816970f75da1399d733f312f1846f5ad58332642297b7fc16168",
"md5": "97ed8d00d4ab34dc4617c333cc5a03b4",
"sha256": "6bc462c74d71e4390f795ff8ec7615b6930246a0a874d849f3bd87e465eef47e"
},
"downloads": -1,
"filename": "disnake_ext_plugins-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97ed8d00d4ab34dc4617c333cc5a03b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 12039,
"upload_time": "2024-09-12T13:37:07",
"upload_time_iso_8601": "2024-09-12T13:37:07.692456Z",
"url": "https://files.pythonhosted.org/packages/66/c0/b0d7a8e7816970f75da1399d733f312f1846f5ad58332642297b7fc16168/disnake_ext_plugins-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91c4165db95505242c3d59aba16257f065a51a8a411f66fe175516e3db90e319",
"md5": "744dd3f0134fcf47a07f05e824a87386",
"sha256": "7ff55e50229ef7394f8a412395c4a6d0df652b01d9aba501c0a766ade75b074f"
},
"downloads": -1,
"filename": "disnake_ext_plugins-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "744dd3f0134fcf47a07f05e824a87386",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 12480,
"upload_time": "2024-09-12T13:37:09",
"upload_time_iso_8601": "2024-09-12T13:37:09.115379Z",
"url": "https://files.pythonhosted.org/packages/91/c4/165db95505242c3d59aba16257f065a51a8a411f66fe175516e3db90e319/disnake_ext_plugins-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 13:37:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Chromosomologist",
"github_project": "disnake-ext-plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "disnake-ext-plugins"
}
JSON
