Onami
a debugging and utility extension for nextcord bots
Read the documentation online.
Fork
Onami is a actively maintained fork of Jishaku for nextcord
onami is an extension for bot developers that enables rapid prototyping, experimentation, and debugging of features for bots.
One of onami's core philosophies is to be dynamic and easy-to-use. Here's the two step install:
- Download onami on the command line using pip:
pip install -U onami
- Load the extension in your bot code before it runs:
bot.load_extension('onami')That's it!
You can also import the module to use the command development utilities.
Index
Command reference
 |
> |
_ctx |
The Context that invoked the command. |
_bot |
The running Bot instance. |
_author_channel_guild_message_msg |
Shortcuts for attributes on _ctx. |
_find_get |
Shortcuts for nextcord.utils functions. |
The underscore prefix on the provided variables is intended to help prevent shadowing when writing large blocks of code within the command.
If you decide that you don't want the prefix, you can disable it by setting the
onami_NO_UNDERSCORE environment variable to true. Each Python command is individually scoped. That means variables you create won't be retained in later invocations.
You can use
onami retain on to change this behavior and retain variables, and onami retain off if you change your mind later. > onami [dis|disassemble]
This command compiles Python code in an asynchronous context, and then disassembles the resulting function into Python bytecode in the style of dis.dis. This allows you to quickly and easily determine the bytecode that results from a given expression or piece of code. The code itself is not actually executed.
 |
> The shell command executes commands within your system shell. |
 |
> |
 |
> This command reads a file from your file system, automatically detecting encoding and (if applicable) highlighting. |
 |
> |
Installing development versions
If you'd like to test the latest versions of onami, you can do so by downloading from the git hosts instead of from PyPI.
From GitHub:
pip install -U "onami @ git+https://github.com/VincentRPS/onami@master"
Please note that the new 2020 dependency resolver now no longer discounts git package sources from reinstall prevention, which means that if you are installing the onami development version multiple times within the same version target you may run into pip just discarding the update.
If you run into such a problem, you can force onami to be reinstalled like this:
From GitHub:
pip install -U --force-reinstall "onami @ git+https://github.com/VincentRPS/onami@master"
You must have installed onami with one of the commands above before doing this else you will probably end up with a broken installation.
Acknowledgements
The documentation and this README uses icons from the Material Design Icon library, which is licensed under the Apache License Version 2.0.
2.3k Dec 31, 2022
977 Jan 5, 2023
1 Jan 16, 2022
8 Mar 21, 2022
6 Nov 19, 2022
3 Jan 10, 2022
1.9k Jan 2, 2023
704 Jan 3, 2023
22 Oct 21, 2022
3 Aug 27, 2022
5 Apr 19, 2022
61 Dec 29, 2022
255 Dec 28, 2022
41 Dec 14, 2022
7 Oct 13, 2021
4 Nov 5, 2021
1 Nov 18, 2021
130 May 28, 2022