diff options
Diffstat (limited to 'v11.2.0/development.html')
| -rw-r--r-- | v11.2.0/development.html | 597 |
1 files changed, 597 insertions, 0 deletions
diff --git a/v11.2.0/development.html b/v11.2.0/development.html new file mode 100644 index 00000000..009361e5 --- /dev/null +++ b/v11.2.0/development.html @@ -0,0 +1,597 @@ +<!doctype html> +<html class="no-js" lang="en" data-content_root="./"> + <head><meta charset="utf-8"/> + <meta name="viewport" content="width=device-width,initial-scale=1"/> + <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> +<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Changelog" href="changelog.html" /><link rel="prev" title="site_api" href="output/pydis_core.site_api.html" /> + + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 --> + <title>Local Development & Testing - Pydis Core v11.2.0</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" /> + <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" /> + <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + + + + +<style> + body { + --color-code-background: #f8f8f8; + --color-code-foreground: black; + --color-api-name: var(--color-link); + + } + @media not print { + body[data-theme="dark"] { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + @media (prefers-color-scheme: dark) { + body:not([data-theme="light"]) { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + } + } +</style></head> + <body> + + <script> + document.body.dataset.theme = localStorage.getItem("theme") || "auto"; + </script> + + +<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> + <symbol id="svg-toc" viewBox="0 0 24 24"> + <title>Contents</title> + <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> + <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> + </svg> + </symbol> + <symbol id="svg-menu" viewBox="0 0 24 24"> + <title>Menu</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> + <line x1="3" y1="12" x2="21" y2="12"></line> + <line x1="3" y1="6" x2="21" y2="6"></line> + <line x1="3" y1="18" x2="21" y2="18"></line> + </svg> + </symbol> + <symbol id="svg-arrow-right" viewBox="0 0 24 24"> + <title>Expand</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> + <polyline points="9 18 15 12 9 6"></polyline> + </svg> + </symbol> + <symbol id="svg-sun" viewBox="0 0 24 24"> + <title>Light mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> + <circle cx="12" cy="12" r="5"></circle> + <line x1="12" y1="1" x2="12" y2="3"></line> + <line x1="12" y1="21" x2="12" y2="23"></line> + <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> + <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> + <line x1="1" y1="12" x2="3" y2="12"></line> + <line x1="21" y1="12" x2="23" y2="12"></line> + <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> + <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> + </svg> + </symbol> + <symbol id="svg-moon" viewBox="0 0 24 24"> + <title>Dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> + <path stroke="none" d="M0 0h24v24H0z" fill="none" /> + <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> + </svg> + </symbol> + <symbol id="svg-sun-half" viewBox="0 0 24 24"> + <title>Auto light/dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> + <path stroke="none" d="M0 0h24v24H0z" fill="none"/> + <circle cx="12" cy="12" r="9" /> + <path d="M13 12h5" /> + <path d="M13 15h4" /> + <path d="M13 18h1" /> + <path d="M13 9h4" /> + <path d="M13 6h1" /> + </svg> + </symbol> + <symbol id="svg-sun-with-moon" viewBox="0 0 24 24"> + <title>Auto light/dark, in light mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" + class="icon-custom-derived-from-feather-sun-and-tabler-moon"> + <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/> + <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/> + <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/> + <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/> + <line x1="19" y1="14.05" x2="20.414" y2="15.464"/> + <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/> + <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/> + <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/> + <line x1="19" y1="5.05" x2="20.414" y2="3.636"/> + <circle cx="14.5" cy="9.55" r="3.6"/> + </svg> + </symbol> + <symbol id="svg-moon-with-sun" viewBox="0 0 24 24"> + <title>Auto light/dark, in dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" + class="icon-custom-derived-from-feather-sun-and-tabler-moon"> + <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/> + <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/> + <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/> + <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/> + <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/> + <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/> + <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/> + <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/> + <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/> + <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/> + </svg> + </symbol> + <symbol id="svg-pencil" viewBox="0 0 24 24"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code"> + <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" /> + <path d="M13.5 6.5l4 4" /> + <path d="M20 21l2 -2l-2 -2" /> + <path d="M17 17l-2 2l2 2" / + </svg> + </symbol> + <symbol id="svg-eye" viewBox="0 0 24 24"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code"> + <path stroke="none" d="M0 0h24v24H0z" fill="none" /> + <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" /> + <path + d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" /> + <path d="M20 21l2 -2l-2 -2" /> + <path d="M17 17l-2 2l2 2" /> + </svg> + </symbol> +</svg> + +<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> +<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> +<label class="overlay sidebar-overlay" for="__navigation"> + <div class="visually-hidden">Hide navigation sidebar</div> +</label> +<label class="overlay toc-overlay" for="__toc"> + <div class="visually-hidden">Hide table of contents sidebar</div> +</label> + +<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a> + + + +<div class="page"> + <header class="mobile-header"> + <div class="header-left"> + <label class="nav-overlay-icon" for="__navigation"> + <div class="visually-hidden">Toggle site navigation sidebar</div> + <i class="icon"><svg><use href="#svg-menu"></use></svg></i> + </label> + </div> + <div class="header-center"> + <a href="index.html"><div class="brand">Pydis Core v11.2.0</div></a> + </div> + <div class="header-right"> + <div class="theme-toggle-container theme-toggle-header"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> + <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + </header> + <aside class="sidebar-drawer"> + <div class="sidebar-container"> + + <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> + + <div class="sidebar-logo-container"> + <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> + </div> + + <span class="sidebar-brand-text">Pydis Core v11.2.0</span> + +</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> + <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> + <input type="hidden" name="check_keywords" value="yes"> + <input type="hidden" name="area" value="default"> +</form> +<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> + <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> +<ul> +<li class="toctree-l1 has-children"><a class="reference internal" href="output/pydis_core.html">Pydis Core</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l2"><a class="reference internal" href="output/pydis_core.exts.html">Exts</a></li> +<li class="toctree-l2 has-children"><a class="reference internal" href="output/pydis_core.utils.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l3 has-children"><a class="reference internal" href="output/pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="output/pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="output/pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="output/pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.caching.html">caching</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.channel.html">channel</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.checks.html">checks</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.function.html">function</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.interactions.html">interactions</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.lock.html">lock</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.logging.html">logging</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.members.html">members</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.messages.html">messages</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.pagination.html">pagination</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.paste_service.html">paste_service</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.regex.html">regex</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/pydis_core.utils.scheduling.html">scheduling</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="output/pydis_core.async_stats.html">async_stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="output/pydis_core.site_api.html">site_api</a></li> +</ul> +</li> +</ul> +<p class="caption" role="heading"><span class="caption-text">Other:</span></p> +<ul class="current"> +<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Local Development & Testing</a></li> +<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> +</ul> + + + + + <ul> + <li class="toctree-l1 has-children "> + + <a class="reference internal" href="versions.html">Versions</a> + <input class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> + <label for="toctree-checkbox-versions"> + <div class="visually-hidden">Toggle child pages in navigation</div> + <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> + </label> + + + <ul> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../main/development.html">main</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.9.2/development.html">v9.9.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.9.1/development.html">v9.9.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.9.0/development.html">v9.9.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.8.0/development.html">v9.8.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.7.0/development.html">v9.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.6.0/development.html">v9.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.5.1/development.html">v9.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.5.0/development.html">v9.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.4.1/development.html">v9.4.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.4.0/development.html">v9.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.3.0/development.html">v9.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.2.0/development.html">v9.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.10.0-alpha.2/development.html">v9.10.0-alpha.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.10.0-alpha.1/development.html">v9.10.0-alpha.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.1.1/development.html">v9.1.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v9.0.0/development.html">v9.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v11.3.0/development.html">v11.3.0</a> + </li> + + <li class="toctree-l2 current-page"> + <a class="version_link reference internal" href="development.html">v11.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v11.1.0/development.html">v11.1.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v11.0.1/development.html">v11.0.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v11.0.0/development.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.7.0/development.html">v10.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.6.0/development.html">v10.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.5.1/development.html">v10.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.5.0/development.html">v10.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.4.0/development.html">v10.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.3.0/development.html">v10.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.2.0/development.html">v10.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.1.0/development.html">v10.1.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v10.0.0/development.html">v10.0.0</a> + </li> + + + <script> + // Make sure we keep any hyperlinked resources when switching version + function updateHash() { + for (let tag of document.getElementsByClassName("version_link")) { + // Extract the original URL + let destination = tag.getAttribute("href"); + if (destination.indexOf("#") !== -1) { + destination = destination.slice(0, destination.indexOf("#")); + } + + // Update the url with the current hash + tag.setAttribute("href", destination + document.location.hash); + } + } + + updateHash(); + addEventListener("hashchange", _ => { updateHash() }); + </script> + </ul> + </li> + </ul> + +</div> +</div> + + </div> + + </div> + </aside> + <div class="main"> + <div class="content"> + <div class="article-container"> + <a href="#" class="back-to-top muted-link"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> + <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> + </svg> + <span>Back to top</span> + </a> + <div class="content-icon-container"> + <div class="view-this-page"> + <a class="muted-link" href="_sources/development.rst.txt" title="View this page"> + <svg><use href="#svg-eye"></use></svg> + <span class="visually-hidden">View this page</span> + </a> +</div> +<div class="theme-toggle-container theme-toggle-content"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> + <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + <article role="main" id="furo-main-content"> + <section id="local-development-testing"> +<h1>Local Development & Testing<a class="headerlink" href="#local-development-testing" title="Link to this heading">¶</a></h1> +<p>To test your features locally, there are a few possible approaches:</p> +<ol class="arabic simple"> +<li><p>Install your local copy of pydis_core into a pre-existing project such as bot</p></li> +<li><p>Use the provided template from the <a class="reference external" href="https://github.com/python-discord/bot-core/blob/main/dev/bot">dev/bot</a> folder</p></li> +</ol> +<p>See below for more info on both approaches.</p> +<p>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.</p> +<section id="option-1"> +<h2>Option 1<a class="headerlink" href="#option-1" title="Link to this heading">¶</a></h2> +<ol class="arabic simple"> +<li><p>Navigate to the project you want to install bot-core in, such as bot or sir-lancebot</p></li> +<li><p>Run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">/path/to/pydis_core</span></code> in the project’s environment</p> +<ul class="simple"> +<li><p>The path provided to install should be the root directory of this project on your machine. +That is, the folder which contains the <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file.</p></li> +<li><p>Make sure to install in the correct environment. Most Python Discord projects use +poetry, so you can run <code class="docutils literal notranslate"><span class="pre">poetry</span> <span class="pre">run</span> <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">/path/to/pydis_core</span></code>.</p></li> +</ul> +</li> +<li><p>You can now use features from your local bot-core changes. +To load new changes, run the install command again.</p></li> +</ol> +</section> +<section id="option-2"> +<h2>Option 2<a class="headerlink" href="#option-2" title="Link to this heading">¶</a></h2> +<ol class="arabic simple"> +<li><p>Copy the <a class="reference external" href="https://github.com/python-discord/bot-core/blob/main/dev/bot">bot template folder</a> 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.</p></li> +<li><p>Run the project</p> +<ul class="simple"> +<li><p>Locally: You can run it on your system using <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">bot</span></code></p></li> +<li><p>Docker: You can run on docker using <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">compose</span> <span class="pre">up</span> <span class="pre">-d</span> <span class="pre">bot</span></code>.</p></li> +</ul> +</li> +<li><p>Configure the environment variables used by the program. +You can set them in an <code class="docutils literal notranslate"><span class="pre">.env</span></code> file in the project root directory. The variables are:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">BOT_TOKEN</span></code> (required): Discord bot token, with all intents enabled</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">GUILD_ID</span></code> (required): The guild the bot should monitor</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">PREFIX</span></code>: The prefix to use for invoking bot commands. Defaults to mentions and <code class="docutils literal notranslate"><span class="pre">!</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">ALLOWED_ROLES</span></code>: A comma seperated list of role IDs which the bot is allowed to mention</p></li> +</ul> +</li> +<li><p>You can now test your changes. You do not need to do anything to reinstall the +library if you modify your code.</p></li> +</ol> +<div class="admonition tip"> +<p class="admonition-title">Tip</p> +<p>The docker-compose included contains services from our other applications +to help you test out certain features. Use them as needed.</p> +</div> +</section> +</section> + + </article> + </div> + <footer> + + <div class="related-pages"> + <a class="next-page" href="changelog.html"> + <div class="page-info"> + <div class="context"> + <span>Next</span> + </div> + <div class="title">Changelog</div> + </div> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + </a> + <a class="prev-page" href="output/pydis_core.site_api.html"> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + <div class="page-info"> + <div class="context"> + <span>Previous</span> + </div> + + <div class="title">site_api</div> + + </div> + </a> + </div> + <div class="bottom-of-page"> + <div class="left-details"> + <div class="copyright"> + Copyright © 2021, Python Discord + </div> + Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s + + <a href="https://github.com/pradyunsg/furo">Furo</a> + + </div> + <div class="right-details"> + + </div> + </div> + + </footer> + </div> + <aside class="toc-drawer"> + + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">Local Development & Testing</a><ul> +<li><a class="reference internal" href="#option-1">Option 1</a></li> +<li><a class="reference internal" href="#option-2">Option 2</a></li> +</ul> +</li> +</ul> + + </div> + </div> + </div> + + + </aside> + </div> +</div><script src="_static/documentation_options.js?v=2d832310"></script> + <script src="_static/doctools.js?v=9a2dae69"></script> + <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/scripts/furo.js?v=4e2eecee"></script> + <script src="_static/changelog.js?v=11ff7913"></script> + </body> +</html>
\ No newline at end of file |