From 7a1270a3782f04548c8c9527006cd1ae6a04b51b Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Sat, 23 Jul 2022 15:20:09 +0000 Subject: Deploying to docs from @ python-discord/bot-core@94c4b408f1afa604ae6907aa28ab694870af20f2 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/.buildinfo | 2 +- main/.doctrees/changelog.doctree | Bin 87608 -> 90529 bytes main/.doctrees/development.doctree | Bin 0 -> 14879 bytes main/.doctrees/environment.pickle | Bin 2651433 -> 2654345 bytes main/.doctrees/index.doctree | Bin 5445 -> 5890 bytes main/.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes main/.doctrees/output/botcore.doctree | Bin 62337 -> 62339 bytes main/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes main/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes .../output/botcore.utils.commands.doctree | Bin 10685 -> 10685 bytes main/.doctrees/output/botcore.utils.doctree | Bin 14052 -> 14052 bytes .../output/botcore.utils.interactions.doctree | Bin 35843 -> 35843 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes main/.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes main/_sources/changelog.rst.txt | 4 + main/_sources/development.rst.txt | 2 + main/_sources/index.rst.txt | 2 + main/changelog.html | 17 +- main/development.html | 446 +++++++++++++++++++++ main/genindex.html | 1 + main/index.html | 2 + main/objects.inv | Bin 1261 -> 1290 bytes main/output/botcore.async_stats.html | 7 +- main/output/botcore.exts.html | 1 + main/output/botcore.html | 35 +- main/output/botcore.site_api.html | 33 +- main/output/botcore.utils.caching.html | 9 +- main/output/botcore.utils.channel.html | 5 +- main/output/botcore.utils.commands.html | 3 +- main/output/botcore.utils.html | 5 +- main/output/botcore.utils.interactions.html | 15 +- main/output/botcore.utils.logging.html | 7 +- main/output/botcore.utils.members.html | 5 +- main/output/botcore.utils.regex.html | 7 +- main/output/botcore.utils.scheduling.html | 19 +- main/py-modindex.html | 1 + main/search.html | 1 + main/searchindex.js | 2 +- main/versions.html | 1 + v7.1.1/.buildinfo | 2 +- v7.1.1/.doctrees/changelog.doctree | Bin 64686 -> 64686 bytes v7.1.1/.doctrees/environment.pickle | Bin 2644038 -> 2644052 bytes v7.1.1/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.1.1/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.1.1/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.1.1/.doctrees/output/botcore.site_api.doctree | Bin 65215 -> 65215 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.1.1/.doctrees/output/botcore.utils.doctree | Bin 13968 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.1.2/.buildinfo | 2 +- v7.1.2/.doctrees/changelog.doctree | Bin 65755 -> 65755 bytes v7.1.2/.doctrees/environment.pickle | Bin 2644038 -> 2644052 bytes v7.1.2/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.1.2/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.1.2/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.1.2/.doctrees/output/botcore.site_api.doctree | Bin 65269 -> 65269 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.1.2/.doctrees/output/botcore.utils.doctree | Bin 13968 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.1.3/.buildinfo | 2 +- v7.1.3/.doctrees/changelog.doctree | Bin 65755 -> 65755 bytes v7.1.3/.doctrees/environment.pickle | Bin 2644038 -> 2644052 bytes v7.1.3/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.1.3/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.1.3/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.1.3/.doctrees/output/botcore.site_api.doctree | Bin 65271 -> 65271 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.1.3/.doctrees/output/botcore.utils.doctree | Bin 13968 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.2.0/.buildinfo | 2 +- v7.2.0/.doctrees/changelog.doctree | Bin 67877 -> 67877 bytes v7.2.0/.doctrees/environment.pickle | Bin 2644038 -> 2644052 bytes v7.2.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.2.0/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.2.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.2.0/.doctrees/output/botcore.site_api.doctree | Bin 65215 -> 65215 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.2.0/.doctrees/output/botcore.utils.doctree | Bin 13968 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.2.1/.buildinfo | 2 +- v7.2.1/.doctrees/changelog.doctree | Bin 73393 -> 73393 bytes v7.2.1/.doctrees/environment.pickle | Bin 2644045 -> 2644059 bytes v7.2.1/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.2.1/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.2.1/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.2.1/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.2.1/.doctrees/output/botcore.utils.doctree | Bin 13968 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes v7.2.2/.buildinfo | 2 +- v7.2.2/.doctrees/changelog.doctree | Bin 75529 -> 75529 bytes v7.2.2/.doctrees/environment.pickle | Bin 2644045 -> 2644059 bytes v7.2.2/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.2.2/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.2.2/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.2.2/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.2.2/.doctrees/output/botcore.utils.doctree | Bin 13968 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes v7.3.0/.buildinfo | 2 +- v7.3.0/.doctrees/changelog.doctree | Bin 80039 -> 80039 bytes v7.3.0/.doctrees/environment.pickle | Bin 2647447 -> 2647461 bytes v7.3.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.3.0/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.3.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.3.0/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.3.0/.doctrees/output/botcore.utils.doctree | Bin 14012 -> 14012 bytes .../output/botcore.utils.interactions.doctree | Bin 30300 -> 30300 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes v7.3.1/.buildinfo | 2 +- v7.3.1/.doctrees/changelog.doctree | Bin 82541 -> 82541 bytes v7.3.1/.doctrees/environment.pickle | Bin 2647447 -> 2647461 bytes v7.3.1/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.3.1/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.3.1/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.3.1/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.3.1/.doctrees/output/botcore.utils.doctree | Bin 14012 -> 14012 bytes .../output/botcore.utils.interactions.doctree | Bin 30300 -> 30300 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes v7.4.0-beta1/.buildinfo | 2 +- v7.4.0-beta1/.doctrees/changelog.doctree | Bin 85478 -> 85478 bytes v7.4.0-beta1/.doctrees/environment.pickle | Bin 2648727 -> 2648741 bytes v7.4.0-beta1/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.4.0-beta1/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.4.0-beta1/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes .../.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.doctree | Bin 14012 -> 14012 bytes .../output/botcore.utils.interactions.doctree | Bin 35843 -> 35843 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes v7.4.0/.buildinfo | 2 +- v7.4.0/.doctrees/changelog.doctree | Bin 85470 -> 85470 bytes v7.4.0/.doctrees/environment.pickle | Bin 2648715 -> 2648729 bytes v7.4.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.4.0/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.4.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.4.0/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.4.0/.doctrees/output/botcore.utils.doctree | Bin 14012 -> 14012 bytes .../output/botcore.utils.interactions.doctree | Bin 35843 -> 35843 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes v7.5.0/.buildinfo | 2 +- v7.5.0/.doctrees/changelog.doctree | Bin 87608 -> 87608 bytes v7.5.0/.doctrees/environment.pickle | Bin 2651437 -> 2651451 bytes v7.5.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.5.0/.doctrees/output/botcore.doctree | Bin 62337 -> 62337 bytes v7.5.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.5.0/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes .../output/botcore.utils.commands.doctree | Bin 10685 -> 10685 bytes v7.5.0/.doctrees/output/botcore.utils.doctree | Bin 14052 -> 14052 bytes .../output/botcore.utils.interactions.doctree | Bin 35843 -> 35843 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes 214 files changed, 569 insertions(+), 85 deletions(-) create mode 100644 main/.doctrees/development.doctree create mode 100644 main/_sources/development.rst.txt create mode 100644 main/development.html diff --git a/main/.buildinfo b/main/.buildinfo index 7030852a..9b63b7ed 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 1028aa66d357f81d1b7118b88bf39ee8 +config: 4485292d889190f3510eac7d8cf14cd0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree index 98e1c108..48f09e55 100644 Binary files a/main/.doctrees/changelog.doctree and b/main/.doctrees/changelog.doctree differ diff --git a/main/.doctrees/development.doctree b/main/.doctrees/development.doctree new file mode 100644 index 00000000..ecc19481 Binary files /dev/null and b/main/.doctrees/development.doctree differ diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle index 6448504f..87f3987e 100644 Binary files a/main/.doctrees/environment.pickle and b/main/.doctrees/environment.pickle differ diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree index a9c8a38c..3853443f 100644 Binary files a/main/.doctrees/index.doctree and b/main/.doctrees/index.doctree differ diff --git a/main/.doctrees/output/botcore.async_stats.doctree b/main/.doctrees/output/botcore.async_stats.doctree index b37c0e0c..1b790b19 100644 Binary files a/main/.doctrees/output/botcore.async_stats.doctree and b/main/.doctrees/output/botcore.async_stats.doctree differ diff --git a/main/.doctrees/output/botcore.doctree b/main/.doctrees/output/botcore.doctree index 980d1864..6b68bef9 100644 Binary files a/main/.doctrees/output/botcore.doctree and b/main/.doctrees/output/botcore.doctree differ diff --git a/main/.doctrees/output/botcore.exts.doctree b/main/.doctrees/output/botcore.exts.doctree index 8b967ce5..c9587da7 100644 Binary files a/main/.doctrees/output/botcore.exts.doctree and b/main/.doctrees/output/botcore.exts.doctree differ diff --git a/main/.doctrees/output/botcore.site_api.doctree b/main/.doctrees/output/botcore.site_api.doctree index 173809b5..bedb582d 100644 Binary files a/main/.doctrees/output/botcore.site_api.doctree and b/main/.doctrees/output/botcore.site_api.doctree differ diff --git a/main/.doctrees/output/botcore.utils.caching.doctree b/main/.doctrees/output/botcore.utils.caching.doctree index 65bd344c..ce8745b6 100644 Binary files a/main/.doctrees/output/botcore.utils.caching.doctree and b/main/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/main/.doctrees/output/botcore.utils.channel.doctree b/main/.doctrees/output/botcore.utils.channel.doctree index ffdd83a2..39a8ebd1 100644 Binary files a/main/.doctrees/output/botcore.utils.channel.doctree and b/main/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/main/.doctrees/output/botcore.utils.commands.doctree b/main/.doctrees/output/botcore.utils.commands.doctree index bd6ce098..896ffa58 100644 Binary files a/main/.doctrees/output/botcore.utils.commands.doctree and b/main/.doctrees/output/botcore.utils.commands.doctree differ diff --git a/main/.doctrees/output/botcore.utils.doctree b/main/.doctrees/output/botcore.utils.doctree index 2a7cb36f..1e6c0561 100644 Binary files a/main/.doctrees/output/botcore.utils.doctree and b/main/.doctrees/output/botcore.utils.doctree differ diff --git a/main/.doctrees/output/botcore.utils.interactions.doctree b/main/.doctrees/output/botcore.utils.interactions.doctree index 7b7b5e5d..04ea9ba4 100644 Binary files a/main/.doctrees/output/botcore.utils.interactions.doctree and b/main/.doctrees/output/botcore.utils.interactions.doctree differ diff --git a/main/.doctrees/output/botcore.utils.logging.doctree b/main/.doctrees/output/botcore.utils.logging.doctree index 7b60d5ed..ceea2a05 100644 Binary files a/main/.doctrees/output/botcore.utils.logging.doctree and b/main/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/main/.doctrees/output/botcore.utils.members.doctree b/main/.doctrees/output/botcore.utils.members.doctree index 24b1ea93..e858b3a5 100644 Binary files a/main/.doctrees/output/botcore.utils.members.doctree and b/main/.doctrees/output/botcore.utils.members.doctree differ diff --git a/main/.doctrees/output/botcore.utils.regex.doctree b/main/.doctrees/output/botcore.utils.regex.doctree index f6af191d..0d9e05d0 100644 Binary files a/main/.doctrees/output/botcore.utils.regex.doctree and b/main/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/main/.doctrees/output/botcore.utils.scheduling.doctree b/main/.doctrees/output/botcore.utils.scheduling.doctree index 49046018..7d8fcd9d 100644 Binary files a/main/.doctrees/output/botcore.utils.scheduling.doctree and b/main/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/main/_sources/changelog.rst.txt b/main/_sources/changelog.rst.txt index 8dce8564..b5d049d9 100644 --- a/main/_sources/changelog.rst.txt +++ b/main/_sources/changelog.rst.txt @@ -4,6 +4,10 @@ Changelog ========= +- :bug:`107` Declare aiodns as a project dependency. +- :support:`107` Add a sample project with boilerplate and documentation explaining how to develop for bot-core. + + - :release:`7.5.0 <23rd July 2022>` - :feature:`101` Add a utility to clean a string or referenced message's content diff --git a/main/_sources/development.rst.txt b/main/_sources/development.rst.txt new file mode 100644 index 00000000..25b8e0a7 --- /dev/null +++ b/main/_sources/development.rst.txt @@ -0,0 +1,2 @@ +.. Stub file to expose the README to sphinx +.. include:: ../dev/README.rst diff --git a/main/_sources/index.rst.txt b/main/_sources/index.rst.txt index 0a375b90..aee7b269 100644 --- a/main/_sources/index.rst.txt +++ b/main/_sources/index.rst.txt @@ -17,6 +17,7 @@ Reference :caption: Other: :hidden: + development changelog @@ -26,4 +27,5 @@ Extras * :ref:`genindex` * :ref:`search` * :repo-file:`Information ` +* :doc:`development` * :doc:`changelog` diff --git a/main/changelog.html b/main/changelog.html index ddb5d95e..3bf4c1c1 100644 --- a/main/changelog.html +++ b/main/changelog.html @@ -3,7 +3,7 @@ - + Changelog - Bot Core Latest (7.5.0) @@ -183,6 +183,7 @@

Other:

@@ -306,6 +307,16 @@

Changelog#

+
+

Next 7.x feature release

    +

  • [Support] #107: Add a sample project with boilerplate and documentation explaining how to develop for bot-core.

    • +
+
+
+

Next 7.x bugfix release

    +

  • [Bug] #107: Declare aiodns as a project dependency.

    • +
+

7.5.0 23rd July 2022

  • [Feature] #101: Add a utility to clean a string or referenced message’s content

    • @@ -505,14 +516,14 @@
    - +
    Previous
    -
    site_api
    +
    Local Development & Testing
     diff --git a/main/development.html b/main/development.html new file mode 100644 index 00000000..83be6143 --- /dev/null +++ b/main/development.html @@ -0,0 +1,446 @@ + + + + + + + + + Local Development & Testing - Bot Core Latest (7.5.0) + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core Latest (7.5.0)
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + +
    + +
    +
    +
    +

    Local Development & Testing#

    +

    To test your features locally, there are a few possible approaches:

    +
      +

    1. Install your local copy of botcore into a pre-existing project such as bot

      2. +

    2. Use the provided template from the dev/bot folder

      3. +
    +

    See below for more info on both approaches.

    +

    What’s going to be common between them is you’ll need to write code to test your feature. +This might mean adding new commands, modifying existing ones, changing utilities, etc. +The steps below should provide most of the groundwork you need, but the exact requirements will +vary by the feature you’re working on.

    +
    +

    Option 1#

    +
      +

    1. Navigate to the project you want to install bot-core in, such as bot or sir-lancebot

      2. +

    2. Run pip install /path/to/botcore in the project’s environment

      +
        +

      • The path provided to install should be the root directory of this project on your machine. +That is, the folder which contains the pyproject.toml file.

        • +

      • Make sure to install in the correct environment. Most Python Discord projects use +poetry, so you can run poetry run pip install /path/to/botcore.

        • +
      +
      3. +

    3. You can now use features from your local bot-core changes. +To load new changes, run the install command again.

      4. +
    +
    +
    +

    Option 2#

    +
      +

    1. Copy the bot template folder to the root of the bot-core project. +This copy is going to be git-ignored, so you’re free to modify it however you like.

      2. +

    2. Run the project

      +
        +

      • Locally: You can run it on your system using python -m bot

        • +

      • Docker: You can run on docker using docker compose up -d bot.

        • +
      +
      3. +

    3. Configure the environment variables used by the program. +You can set them in an .env file in the project root directory. The variables are:

      +
        +

      • TOKEN (required): Discord bot token, with all intents enabled

        • +

      • GUILD_ID (required): The guild the bot should monitor

        • +

      • PREFIX: The prefix to use for invoking bot commands. Defaults to mentions and !

        • +

      • ALLOWED_ROLES: A comma seperated list of role IDs which the bot is allowed to mention

        • +
      +
      4. +

    4. You can now test your changes. You do not need to do anything to reinstall the +library if you modify your code.

      5. +
    +
    +

    Tip

    +

    The docker-compose included contains services from our other applications +to help you test out certain features. Use them as needed.

    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + + \ No newline at end of file diff --git a/main/genindex.html b/main/genindex.html index 3810a8c7..ca556bf9 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -181,6 +181,7 @@

Other:

diff --git a/main/index.html b/main/index.html index cbac4b0a..6709084f 100644 --- a/main/index.html +++ b/main/index.html @@ -183,6 +183,7 @@

Other:

@@ -339,6 +340,7 @@

  • Index

  • Search Page

  • Information

    • +

  • Local Development & Testing

  • Changelog

    • diff --git a/main/objects.inv b/main/objects.inv index 26f12220..1c71ad07 100644 Binary files a/main/objects.inv and b/main/objects.inv differ diff --git a/main/output/botcore.async_stats.html b/main/output/botcore.async_stats.html index 3562838f..7b85006a 100644 --- a/main/output/botcore.async_stats.html +++ b/main/output/botcore.async_stats.html @@ -183,6 +183,7 @@

    Other:

    @@ -309,12 +310,12 @@

    An async transport method for statsd communication.

    -class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]#
    +class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]#

    Bases: StatsClientBase

    An async implementation of statsd.client.base.StatsClientBase that supports async stat communication.

    -__init__(loop, host='localhost', port=8125, prefix=None)[source]#
    +__init__(loop, host='localhost', port=8125, prefix=None)[source]#

    Create a new AsyncStatsClient.

    Parameters:
    @@ -331,7 +332,7 @@
    -async create_socket()[source]#
    +async create_socket()[source]#

    Use asyncio.loop.create_datagram_endpoint from the loop given on init to create a socket.

    Return type:
    diff --git a/main/output/botcore.exts.html b/main/output/botcore.exts.html index 70de4fc8..4e6f29bc 100644 --- a/main/output/botcore.exts.html +++ b/main/output/botcore.exts.html @@ -183,6 +183,7 @@

    Other:

    diff --git a/main/output/botcore.html b/main/output/botcore.html index e56f876b..a632fa24 100644 --- a/main/output/botcore.html +++ b/main/output/botcore.html @@ -183,6 +183,7 @@

    Other:

    @@ -309,17 +310,17 @@

    Useful utilities and tools for Discord bot development.

    -class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
    +class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#

    Bases: Bot

    A sub-class that implements many common features that Python Discord bots use.

    -__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
    +__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#

    Initialise the base bot instance.

    Parameters:
      -

    • guild_id (int) – The ID of the guild use for wait_until_guild_available().

      • +

    • guild_id (int) – The ID of the guild used for wait_until_guild_available().

    • allowed_roles (list) – A list of role IDs that the bot is allowed to mention.

    • http_session (aiohttp.ClientSession) – The session to use for the bot.

    • redis_session (Optional[RedisSession]) – The async_rediscache.RedisSession to use for the bot.

      • @@ -333,7 +334,7 @@ a dummy statsd client will be created.

      -async add_cog(cog)[source]#
      +async add_cog(cog)[source]#

      Add the given cog to the bot and log the operation.

      Return type:
      @@ -344,7 +345,7 @@ a dummy statsd client will be created.

      -add_command(command)[source]#
      +add_command(command)[source]#

      Add command as normal and then add its root aliases to the bot.

      Return type:
      @@ -355,7 +356,7 @@ a dummy statsd client will be created.

      -clear()[source]#
      +clear()[source]#

      Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.

      Return type:
      @@ -366,7 +367,7 @@ a dummy statsd client will be created.

      -async close()[source]#
      +async close()[source]#

      Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.

      Return type:
      @@ -377,7 +378,7 @@ a dummy statsd client will be created.

      -async load_extensions(module)[source]#
      +async load_extensions(module)[source]#

      Load all the extensions within the given module and save them to self.all_extensions.

      This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

      @@ -389,7 +390,7 @@ a dummy statsd client will be created.

      -async log_to_dev_log(message)[source]#
      +async log_to_dev_log(message)[source]#

      Log the given message to #dev-log.

      Return type:
      @@ -400,7 +401,7 @@ a dummy statsd client will be created.

      -async on_guild_available(guild)[source]#
      +async on_guild_available(guild)[source]#

      Set the internal guild available event when self.guild_id becomes available.

      If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and guild_available_but_cache_empty event will be emitted.

      @@ -413,7 +414,7 @@ will not be set and guild_available_but_cache_empty event will be e
      -async on_guild_unavailable(guild)[source]#
      +async on_guild_unavailable(guild)[source]#

      Clear the internal guild available event when self.guild_id becomes unavailable.

      Return type:
      @@ -424,7 +425,7 @@ will not be set and guild_available_but_cache_empty event will be e
      -async ping_services()[source]#
      +async ping_services()[source]#

      Ping all required services on setup to ensure they are up before starting.

      Return type:
      @@ -435,7 +436,7 @@ will not be set and guild_available_but_cache_empty event will be e
      -remove_command(name)[source]#
      +remove_command(name)[source]#

      Remove a command/alias as normal and then remove its root aliases from the bot.

      Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit bot.all_commands.

      @@ -448,7 +449,7 @@ To remove them, either remove the entire command or manually edit bot.all_
      -async setup_hook()[source]#
      +async setup_hook()[source]#

      An async init to startup generic services.

      Connects to statsd, and calls AsyncStatsClient.create_socket @@ -462,7 +463,7 @@ and

      -async wait_until_guild_available()[source]#
      +async wait_until_guild_available()[source]#

      Wait until the guild that matches the guild_id given at init is available (and the cache is ready).

      The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.

      @@ -477,12 +478,12 @@ gateway event before giving up and thus not populating the cache for unavailable
      -exception StartupError(base)[source]#
      +exception StartupError(base)[source]#

      Bases: Exception

      Exception class for startup errors.

      -__init__(base)[source]#
      +__init__(base)[source]#
      diff --git a/main/output/botcore.site_api.html b/main/output/botcore.site_api.html index 9252f0ea..71182234 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -3,7 +3,7 @@ - + site_api - Bot Core Latest (7.5.0) @@ -183,6 +183,7 @@

    Other:

    @@ -309,12 +310,12 @@

    An API wrapper around the Site API.

    -class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
    +class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#

    Bases: object

    A wrapper for the Django Site API.

    -__init__(site_api_url, site_api_token, **session_kwargs)[source]#
    +__init__(site_api_url, site_api_token, **session_kwargs)[source]#

    Initialize a new APIClient instance.

    Parameters:
    @@ -329,7 +330,7 @@
    -async close()[source]#
    +async close()[source]#

    Close the aiohttp session.

    Return type:
    @@ -340,7 +341,7 @@
    -async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Send a DELETE request to the site API and return the JSON response.

    Parameters:
    @@ -361,7 +362,7 @@
    -async get(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with GET passed as the method.

    Return type:
    @@ -372,7 +373,7 @@
    -async static maybe_raise_for_status(response, should_raise)[source]#
    +async static maybe_raise_for_status(response, should_raise)[source]#

    Raise ResponseCodeError for non-OK response if an exception should be raised.

    Parameters:
    @@ -392,7 +393,7 @@
    -async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with PATCH passed as the method.

    Return type:
    @@ -403,7 +404,7 @@
    -async post(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with POST passed as the method.

    Return type:
    @@ -414,7 +415,7 @@
    -async put(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with PUT passed as the method.

    Return type:
    @@ -425,7 +426,7 @@
    -async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

    Send an HTTP request to the site API and return the JSON response.

    Parameters:
    @@ -452,12 +453,12 @@
    -exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
    +exception ResponseCodeError(response, response_json=None, response_text=None)[source]#

    Bases: ValueError

    Raised in APIClient.request() when a non-OK HTTP response is received.

    -__init__(response, response_json=None, response_text=None)[source]#
    +__init__(response, response_json=None, response_text=None)[source]#

    Initialize a new ResponseCodeError instance.

    Parameters:
    @@ -472,7 +473,7 @@
    -__str__()[source]#
    +__str__()[source]#

    Return a string representation of the error.

    @@ -485,12 +486,12 @@