## This module is built on top of Jishaku.
> 1. Download jishaku
> ```bash
> pip install -U "jishaku @ git+https://github.com/Gorialis/jishaku@master"
> ```
jejudo is an extension for bot developers that enables rapid prototyping, experimentation, and debugging of features for bots.
One of jejudo's core philosophies is to be dynamic and easy-to-use. Here's the two step install:
> 1. Download jejudo on the command line using pip:
> ```bash
> pip install -U jejudo
> ```
> 2. Load the extension in your bot code before it runs:
> ```python
> bot.load_extension('jejudo')
> # or
> await bot.load_extension('jejudo')
> ```
> That's it!
You can also import the module to use the command development utilities.
## Command reference
<table>
<tr>
<td width="60px">
<img align="left" width="50" src="https://github.com/Gorialis/jishaku/blob/master/.github/assets/python_logo.svg">
</td>
<td>
<h4>> <code>jejudo [py|python] <argument></code></h4>
The Python commands execute or evaluate Python code passed into them.
It supports simple expressions:
<br><br> <!-- Horrifying that I have to do this -->
<blockquote>
<p>> <i>jejudo py 3+4</i></p>
<img align="left" width="50" height="50" src="https://github.com/Gorialis/jishaku/blob/master/.github/assets/beep_bot.svg">
<p><b>Beep Bot</b></p>
7
</blockquote>
<br>
It also supports async expressions:
<br><br>
<blockquote>
<p>> <i>jejudo py await _ctx.pins()</i></p>
<img align="left" width="50" height="50" src="https://github.com/Gorialis/jishaku/blob/master/.github/assets/beep_bot.svg">
<p><b>Beep Bot</b></p>
[<Message id=123456789012345678 ...>, ...]
</blockquote>
<br>
You can pass in codeblocks for longer blocks of code to execute, and you can use <code>yield</code> to return intermediate results within your processing.
<br><br>
The <i>inspect</i> variant of the command will return a codeblock with detailed inspection information on all objects returned.
<br><br>
The variables available by default in all execution contexts are:
<br><br>
<table>
<tr>
<td><code>_ctx</code></td>
<td>
The <a href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context">Context</a> that invoked the command.
</td>
</tr>
<tr>
<td><code>_bot</code></td>
<td>
The running <a href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot">Bot</a> instance.
</td>
</tr>
<tr>
<td><code>_author</code><br><code>_channel</code><br><code>_guild</code><br><code>_me</code><br><code>_message</code><br><code>_msg</code></td>
<td>
Shortcuts for attributes on <a href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context"><code>_ctx</code></a>.
</td>
</tr>
<tr>
<td><code>_find</code><br><code>_get</code></td>
<td>
Shortcuts for <a href="https://discordpy.readthedocs.io/en/latest/api.html#utility-functions"><code>discord.utils</code></a> functions.
</td>
</tr>
</table>
<br>
The underscore prefix on the provided variables is intended to help prevent shadowing when writing large blocks of code within the command.
<br>
If you decide that you don't want the prefix, you can disable it by setting the <code>jejudo_NO_UNDERSCORE</code> environment variable to <code>true</code>.
<br><br>
Each Python command is individually scoped. That means variables you create won't be retained in later invocations.
<br>
</td>
</tr>
</table>
<table>
<tr>
<td width="60px">
<img align="left" width="50" src="https://github.com/Gorialis/jishaku/blob/master/.github/assets/terminal.svg">
</td>
<td>
<h4>> <code>jejudo [sh|shell] <argument></code></h4>
The shell command executes commands within your system shell.
<br><br>
If you're on Linux and are using a custom shell, jejudo will obey the <code>SHELL</code> environment variable, otherwise, it will use <code>/bin/bash</code>.
<br>
On Windows, jejudo will use PowerShell if it's detected, otherwise, it will use Command Prompt.
<br><br>
</td>
</tr>
</table>
<table>
<tr>
<td width="60px">
<img align="left" width="50" src="https://github.com/Gorialis/jishaku/blob/master/.github/assets/extension.svg">
</td>
<td>
<h4>> <code>jejudo [load|reload] [extensions...]</code></h4>
<h4>> <code>jejudo unload [extensions...]</code></h4>
These commands load, reload, or unload extensions on your bot.
<br><br>
You can reload jejudo itself with <code>jsk reload jejudo</code>.
<br>
<code>jsk reload ~</code> will reload all extensions on your bot.
<br><br>
You can load, reload, or unload multiple extensions at once: <code>jsk reload cogs.one cogs.two</code>
<br><br>
<h4>> <code>jejudo shutdown</code></h4>
This command gracefully shuts down your bot.
<br><br>
<h4>> <code>jejudo rtt</code></h4>
This command calculates <a href="https://en.wikipedia.org/wiki/Round-trip_delay">Round-Trip Time</a> for your bot to the API. It does this by calculating response time samples, so you can tell if your bot is being slow or not.
<br><br>
</td>
</tr>
</table>
Raw data
{
"_id": null,
"home_page": "",
"name": "jejudo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "jejudo,jishkucord,py-cord,discord,cog,repl,extension,jishaku",
"author": "blket.dev",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f9/e5/50fe0bb1b8c5034154c410069f8b4cf3234b2e17b9b9100558653201a4b4/jejudo-2.7.5.tar.gz",
"platform": null,
"description": "## This module is built on top of Jishaku.\r\n> 1. Download jishaku\r\n> ```bash\r\n> pip install -U \"jishaku @ git+https://github.com/Gorialis/jishaku@master\"\r\n> ```\r\n\r\n\r\njejudo is an extension for bot developers that enables rapid prototyping, experimentation, and debugging of features for bots.\r\n\r\nOne of jejudo's core philosophies is to be dynamic and easy-to-use. Here's the two step install:\r\n\r\n> 1. Download jejudo on the command line using pip:\r\n> ```bash\r\n> pip install -U jejudo\r\n> ```\r\n> 2. Load the extension in your bot code before it runs:\r\n> ```python\r\n> bot.load_extension('jejudo')\r\n> # or\r\n> await bot.load_extension('jejudo')\r\n> ```\r\n> That's it!\r\n\r\nYou can also import the module to use the command development utilities.\r\n\r\n## Command reference\r\n\r\n<table>\r\n <tr>\r\n <td width=\"60px\">\r\n <img align=\"left\" width=\"50\" src=\"https://github.com/Gorialis/jishaku/blob/master/.github/assets/python_logo.svg\">\r\n </td>\r\n <td>\r\n <h4>> <code>jejudo [py|python] <argument></code></h4>\r\n The Python commands execute or evaluate Python code passed into them.\r\n It supports simple expressions:\r\n <br><br> <!-- Horrifying that I have to do this -->\r\n <blockquote>\r\n <p>> <i>jejudo py 3+4</i></p>\r\n <img align=\"left\" width=\"50\" height=\"50\" src=\"https://github.com/Gorialis/jishaku/blob/master/.github/assets/beep_bot.svg\">\r\n <p><b>Beep Bot</b></p>\r\n 7\r\n </blockquote>\r\n <br>\r\n It also supports async expressions:\r\n <br><br>\r\n <blockquote>\r\n <p>> <i>jejudo py await _ctx.pins()</i></p>\r\n <img align=\"left\" width=\"50\" height=\"50\" src=\"https://github.com/Gorialis/jishaku/blob/master/.github/assets/beep_bot.svg\">\r\n <p><b>Beep Bot</b></p>\r\n [<Message id=123456789012345678 ...>, ...]\r\n </blockquote>\r\n <br>\r\n You can pass in codeblocks for longer blocks of code to execute, and you can use <code>yield</code> to return intermediate results within your processing.\r\n <br><br>\r\n The <i>inspect</i> variant of the command will return a codeblock with detailed inspection information on all objects returned.\r\n <br><br>\r\n The variables available by default in all execution contexts are:\r\n <br><br>\r\n <table>\r\n <tr>\r\n <td><code>_ctx</code></td>\r\n <td>\r\n The <a href=\"https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context\">Context</a> that invoked the command.\r\n </td>\r\n </tr>\r\n <tr>\r\n <td><code>_bot</code></td>\r\n <td>\r\n The running <a href=\"https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot\">Bot</a> instance.\r\n </td>\r\n </tr>\r\n <tr>\r\n <td><code>_author</code><br><code>_channel</code><br><code>_guild</code><br><code>_me</code><br><code>_message</code><br><code>_msg</code></td>\r\n <td>\r\n Shortcuts for attributes on <a href=\"https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context\"><code>_ctx</code></a>.\r\n </td>\r\n </tr>\r\n <tr>\r\n <td><code>_find</code><br><code>_get</code></td>\r\n <td>\r\n Shortcuts for <a href=\"https://discordpy.readthedocs.io/en/latest/api.html#utility-functions\"><code>discord.utils</code></a> functions.\r\n </td>\r\n </tr>\r\n </table>\r\n <br>\r\n The underscore prefix on the provided variables is intended to help prevent shadowing when writing large blocks of code within the command.\r\n <br>\r\n If you decide that you don't want the prefix, you can disable it by setting the <code>jejudo_NO_UNDERSCORE</code> environment variable to <code>true</code>.\r\n <br><br>\r\n Each Python command is individually scoped. That means variables you create won't be retained in later invocations.\r\n <br>\r\n </td>\r\n </tr>\r\n</table>\r\n\r\n<table>\r\n <tr>\r\n <td width=\"60px\">\r\n <img align=\"left\" width=\"50\" src=\"https://github.com/Gorialis/jishaku/blob/master/.github/assets/terminal.svg\">\r\n </td>\r\n <td>\r\n <h4>> <code>jejudo [sh|shell] <argument></code></h4>\r\n The shell command executes commands within your system shell.\r\n <br><br>\r\n If you're on Linux and are using a custom shell, jejudo will obey the <code>SHELL</code> environment variable, otherwise, it will use <code>/bin/bash</code>.\r\n <br>\r\n On Windows, jejudo will use PowerShell if it's detected, otherwise, it will use Command Prompt.\r\n <br><br>\r\n </td>\r\n </tr>\r\n</table>\r\n\r\n<table>\r\n <tr>\r\n <td width=\"60px\">\r\n <img align=\"left\" width=\"50\" src=\"https://github.com/Gorialis/jishaku/blob/master/.github/assets/extension.svg\">\r\n </td>\r\n <td>\r\n <h4>> <code>jejudo [load|reload] [extensions...]</code></h4>\r\n <h4>> <code>jejudo unload [extensions...]</code></h4>\r\n These commands load, reload, or unload extensions on your bot.\r\n <br><br>\r\n You can reload jejudo itself with <code>jsk reload jejudo</code>.\r\n <br>\r\n <code>jsk reload ~</code> will reload all extensions on your bot.\r\n <br><br>\r\n You can load, reload, or unload multiple extensions at once: <code>jsk reload cogs.one cogs.two</code>\r\n <br><br>\r\n <h4>> <code>jejudo shutdown</code></h4>\r\n This command gracefully shuts down your bot.\r\n <br><br>\r\n <h4>> <code>jejudo rtt</code></h4>\r\n This command calculates <a href=\"https://en.wikipedia.org/wiki/Round-trip_delay\">Round-Trip Time</a> for your bot to the API. It does this by calculating response time samples, so you can tell if your bot is being slow or not.\r\n <br><br>\r\n </td>\r\n </tr>\r\n</table>\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "discord is py-cord bot debug tools",
"version": "2.7.5",
"project_urls": null,
"split_keywords": [
"jejudo",
"jishkucord",
"py-cord",
"discord",
"cog",
"repl",
"extension",
"jishaku"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1417bdac9b4c645feb98743f8f6134a6e373fc5aa32b73c2416f5532e0845cf3",
"md5": "f23d78765d21da1dd1f5477a8e650c82",
"sha256": "bce16243a41dfa2e4fd157c5af37bdf41ca27e1578109c1a793e51c29b1e8593"
},
"downloads": -1,
"filename": "jejudo-2.7.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f23d78765d21da1dd1f5477a8e650c82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 42776,
"upload_time": "2024-01-30T16:47:14",
"upload_time_iso_8601": "2024-01-30T16:47:14.791708Z",
"url": "https://files.pythonhosted.org/packages/14/17/bdac9b4c645feb98743f8f6134a6e373fc5aa32b73c2416f5532e0845cf3/jejudo-2.7.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9e550fe0bb1b8c5034154c410069f8b4cf3234b2e17b9b9100558653201a4b4",
"md5": "12b817187dc2c67997f265732410f200",
"sha256": "421ab0358cdf283c2b6819fa115b72591d06708adf99983ff04ef7d3f1377689"
},
"downloads": -1,
"filename": "jejudo-2.7.5.tar.gz",
"has_sig": false,
"md5_digest": "12b817187dc2c67997f265732410f200",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 36182,
"upload_time": "2024-01-30T16:47:18",
"upload_time_iso_8601": "2024-01-30T16:47:18.368861Z",
"url": "https://files.pythonhosted.org/packages/f9/e5/50fe0bb1b8c5034154c410069f8b4cf3234b2e17b9b9100558653201a4b4/jejudo-2.7.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 16:47:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jejudo"
}
JSON