From cfc0e3658490caaf9e05354278961a8794de0aa3 Mon Sep 17 00:00:00 2001 From: YumYummity <103061664+YumYummity@users.noreply.github.com> Date: Mon, 29 Jul 2024 13:21:01 -0400 Subject: [PATCH] Bump version, add cog docs --- Examples/test.py | 2 +- README.md | 3 +++ docs/README.md | 24 ------------------------ gpyConsole/__init__.py | 2 +- 4 files changed, 5 insertions(+), 26 deletions(-) delete mode 100644 docs/README.md diff --git a/Examples/test.py b/Examples/test.py index 51b042b..4a1f76b 100644 --- a/Examples/test.py +++ b/Examples/test.py @@ -73,5 +73,5 @@ async def hi(ctx: commands.Context): bot.run( - "gapi_g3ApoXCAoHXpEda7YvyU2KPHLepbBxHHIv0sdA7nnkJ5Gt353rFuDlWq8RdlYmer9C58jaTCXKjPjtcCcBLwgA==" + "gapi_token" ) diff --git a/README.md b/README.md index d28e92b..000535f 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,9 @@ New events were added that are accessible like any other guilded.py event. - `on_console_command_error` - `on_console_message` +### Console Cogs +All cogs should be replaced with a ConsoleCog; it implements guilded.py's Cog feature so it will work the same. + ### You can stop the console ```python diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index fde8cd2..0000000 --- a/docs/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# gpyConsole: things to know - -The console has to be started manually. Try something like this: -```python -@bot.event -async def on_ready(): - print(f"Logged in as {bot.user}") - if not bot._console_running: - bot.start_console() -``` - -### Missing Converters -Any converter that relies on the local server will not be available. This includes: -- guilded.Role -- guilded.Member -- guilded.ChatMessage -- guilded.Attachment - -### New Events -New events were added that are accessible like any other guilded.py event. -- `on_console_command_completion` -- `on_console_command` -- `on_console_command_error` -- `on_console_message` \ No newline at end of file diff --git a/gpyConsole/__init__.py b/gpyConsole/__init__.py index c37308f..27e2b5b 100644 --- a/gpyConsole/__init__.py +++ b/gpyConsole/__init__.py @@ -2,7 +2,7 @@ gpy-console """ -__version__ = "0.1.1a" +__version__ = "0.2.1" try: import guilded