Metadata-Version: 2.1
Name: lightbulb-ext-hecate
Version: 0.1.5
Summary: File driven wrappers around lightbulb extensions and plugins.
Home-page: https://github.com/radkii/lightbulb-ext-hecate
License: MIT
Author: Radkii
Author-email: real.radkii@gmail.com
Requires-Python: >=3.9,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: hikari-lightbulb (>=2.3.1,<3.0.0)
Project-URL: Repository, https://github.com/radkii/lightbulb-ext-hecate
Description-Content-Type: text/markdown

# Hecate
File driven wrappers around lightbulb extensions and plugins.

## Installation
Hecate can be installed through [pip](https://pip.pypa.io/en/stable/)
```bash
pip install lightbulb-ext-hecate
```

## First Steps
A pong slash command template for a basic hecate extension can be generated by running
```bash
python -m lightbulb.ext.hecate --template REL_PATH_TO_PY
```
granted a .py extension file already exists in the desired directory.

The following directory structure
```bash
.
└── extension.py
```
will become
```bash
.
├── slash-commands
│   ├── pong_count.py
│   └── ping.py
├── __modify__.py
└── extension.py
```

## Usage
```python
# Import the Plugin class
from lightbulb.ext.hecate import Plugin

# Create a Plugin instance (__file__ is necessary to fetch the commands and events in other files)
plugin = Plugin('EXTENSION', __file__)

# Plain lightbulb extension load method
def load(bot):
    bot.add_plugin(plugin)
```
