discord-beacon 3.0.0__tar.gz

discord_beacon-3.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

discord_beacon-3.0.0/NOTICE

@@ -0,0 +1,9 @@
+Beacon
+Copyright 2024-2026 Dopamine Studios
+
+This project includes Beacon developed by Dopamine Studios.
+(https://github.com/dopaminestudios/beacon)
+
+Under the terms of the Apache License 2.0, you must preserve this
+attribution in your source code and any distributed versions of
+this software.

discord_beacon-3.0.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: discord-beacon
+Version: 3.0.0
+Summary: Initialise a production-ready Discord.py bot in just 4 lines of code. Smart and automated command syncing, preconditions (and its presets), easy-to-use in-Discord dashboard, and more. A Dopamine Studios project.
+Author: ismite
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: discord.py>=2.6.4
+Requires-Dist: aiosqlite
+Requires-Dist: psutil
+Requires-Dist: pillow
+Requires-Dist: geocoder
+Dynamic: license-file
+
+<div align="center">
+
+# Beacon
+
+</div>
+
+<p align="center">
+  <a href="https://pypi.org/project/discord-beacon/">
+    <img src="https://img.shields.io/pypi/v/beacon?style=for-the-badge&logo=pypi&color=blue" />
+  </a>
+  <a href="https://www.python.org/">
+  <img src="https://img.shields.io/badge/python-3.12+-yellow?style=for-the-badge&logo=python&logoColor=white" />
+</a>
+  <a href="https://github.com/smite-codes/beacon/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/smite-codes/beacon?style=for-the-badge&color=orange" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="#installing"><b>Install</b></a> •
+  <a href="#features"><b>Features</b></a> •
+  <a href="#comparison-with-sapphire-framework-and-bare-bones-discordpy"><b>Comparison</b></a> •
+  <a href="#implementation-example"><b>Quick Start</b></a> •
+  <a href="https://github.com/smite-codes/beacon/issues"><b>Report Bug</b></a>
+</p>
+
+Beacon is an **Unopinionated Framework** for discord.py which allows you to initialize a production-ready Discord bot in just 4 lines of code. It is designed to streamline the development of scalable Discord applications by automating the process of registering commands and simplify the process of creating them, diagnosing the bot, and various other utilities such as a paginator helper and "Private View" helpers which let only the user who initiated the interaction to interact with the components like buttons.
+
+A **Dopamine Studios** product.
+
+---
+## Installing
+
+**Use Python 3.12 or higher:**
+
+```Linux/MacOS
+# Linux/MacOS
+python3 -m pip install -U discord-beacon
+```
+```Windows
+# Windows
+py -3 -m pip install -U discord-beacon
+```
+## Features
+
+### 1. Smart Command Syncing
+
+The framework includes a Command Registry that compares local command states with remote Discord API states. This ensures that global and guild-specific slash commands are only synced when changes are detected, preventing unnecessary API overhead and rate-limit triggers.
+
+### 2. Beacon Commands decorator with Preconditions
+The `@beacon_commands.command` decorator replaces the standard discord.py version, allowing you to define permissions and cooldowns in a single line.
+
+* **Simplified Syntax:** Define name, description, permissions, and cooldowns within one decorator.
+* **Implicit Global Cooldown:** Every command is protected by the bot's global rate limit by default.
+* **Group Support:** Use `beacon_commands.Group` to apply permissions or cooldowns to an entire category of subcommands at once.
+
+```python
+from beacon import beacon_commands
+
+@beacon_commands.command(
+    name="ban",
+    permissions_preset="moderator",
+    global_cooldown=True
+)
+async def ban_member(interaction: discord.Interaction, member: discord.Member):
+    await member.ban()
+    await interaction.response.send_message(f"{member.display_name} has been banned.")
+```
+
+### 3. Precondition Decorators
+If you prefer using standard `app_commands`, you can use the standalone `@preconditions` decorators to enforce rules dynamically.
+
+* **Permission Presets:** Use pre-defined roles like `"admin"`, `"moderator"`, or `"support"` instead of manual permission bitfields.
+* **Advanced Logic:** Includes `has_permissions_any` (pass if user has one of many) and `has_permissions` (must have all).
+* **Smart Rate Limiting:** Easily implement command-specific or bot-wide global cooldowns to prevent spam.
+
+| Preset | Required Permissions |
+| :--- | :--- |
+| `"bot_owner"` | Restricts usage to the bot owner/team owners. |
+| `moderator` | Manage Messages, Kick Members, Ban Members |
+| `admin` | Administrator |
+| `giveaways` | Manage Guild, Manage Messages |
+| `automation` | Manage Guild, Manage Messages, Manage Channels |
+| `manager` | Manage Guild, Manage Roles, Manage Channels |
+| `support` | Manage Messages, Read Message History |
+| `security` | View Audit Log, Moderate Members |
+| `community` | Manage Expressions, Manage Threads, Create Public Threads |
+| `technical` | Manage Webhooks, Manage Guild |
+
+### 4. In-Discord Owner Dashboard
+
+No need for terminal access/SSH. This simple to use and feature-rich dashboard for bot owners allows you to unload/reload cogs on the fly, restart the bot, or check logs, accessed using `/od`. This allows bot owner(s) to manage, diagnose the bot right within Discord itself. This dashboard allows the bot to run idefinitely without restarts:
+
+* **Cog Management:** Dynamic loading, unloading, and uploading/replacing of cogs.
+* **Power State:** Remote shutdown and process-level restarts.
+* **Logs:** Real-time retrieval of log files via the Discord UI.
+* **Manual Command Syncs:** Sync commands manually globally or within only the current guild.
+### 5. Diagnostics
+
+The built-in `Diagnostics` "cog" (module) provides real-time monitoring of the bot's health, including:
+
+* **Latency:** High precision API, Heartbeat, and Round-trip latency monitoring.
+* **Resource Utilization:** CPU and RAM usage tracking via `psutil`.
+* **Graphs:** Generate graphs for the bot's latency for visual performance auditing.
+* **Host Device Metrics:** Integration with system sensors to report host location and battery status, if available.
+
+### 6. Built-in Logging Backend
+
+* A robust Logging Manager utilizing `aiosqlite` that can be plugged into any feature of your bot to implement a logging system, such as for mod logs, action logs, etc.
+
+---
+
+### Comparison (with Sapphire Framework and standard discord.py)
+
+| Feature                                                |     Beacon      |      Sapphire (js/ts)       |           discord.py            |
+|:-------------------------------------------------------|:---------------------------:|:---------------------------:|:-------------------------------:|
+| **Easy Setup**                                         | **✅ <br/>(minimal boilerplate)** | **❌** <br/>(Lots of boilerplate) |              **❌**              |
+| **Preconditions Support**                              |            **✅**            |            **✅**            |              **❌**              |
+| **Presets for Permission Checks<br/>in Preconditions** |            **✅**            |             **❌**            |              **❌**              |
+| **No tantrums over different structure**               |            **✅**            |            **❌**            |              **✅**              |
+| **Python's ease of use**                               |            **✅**            |            **❌**            |              **✅**              |
+| **Smart Commands Sync**                                |       **✅<br/>(Built-in)**       |   **✅** <br/>(Through plugins)   |  **❌** <br/>(not included/standard)  |
+| **In-Discord Dashboard**                               |      **✅ <br/>(Built-in)**       |            **❌**            |              **❌**              |
+| **Latency Graphs**                                     |      **✅ <br/>(Built-in)**       |            **❌**            |              **❌**              |
+| **Scalability***                                       |            **✅**            |            **✅**            |              **✅**              |
+| **Fast Iteration**                                     |            **✅**            |            **❌**            |              **❌**              |
+| **Strict TypeScript Rules**                            |            **❌**            |            **✅**            |              **❌**              |
+| **Built-in Resource Monitoring**                       |            **✅**            |            **❌**            |              **❌**              |
+| **Is it JS, tho?**                                     |            **❌**            |            **✅**            |              **❌**              |
+| **Wins Imaginary Benchmarks**                          |            **❌**            |            **✅**            |              **❌**              |
+
+<sup>*Scalability refers to ability to run without problems when the bot is in tens of thousands of servers or more. While it's a common myth that "Python is bloated", that's not true in the context of Discord bots. The real bottleneck in popular Discord bots always comes down to network, not code execution time or memory usage.</sup>
+
+
+---
+
+## Implementation Example
+
+To initialize a bot using the Beacon, follow the following example:
+
+```python
+import discord
+from beacon import Bot
+
+bot = Bot(command_prefix="?", cogs_path="your cogs/modules folder path here*", logging_path="path to .sqlite, .db, or .db3 file; only define if you want to use this logging backend.", default_diagnostics=True, intents=discord.Intents.default()) # If no cogs folder is defined, it will default to "cogs". If no logging path, logging will be disabled.
+
+bot.run("YOUR_BOT_TOKEN_HERE")
+```
+<sub>*Note: All .py files will be attempted to be loaded in the folder. It's recommended to only use the defined path for cogs/extensions/modules.</sub>
+
+---
+
+## Requirements
+
+* `discord.py`
+* `aiosqlite`
+* `psutil`
+* `Pillow`
+* `geocoder`
+
+---
+
+## License & Attribution
+
+Beacon is licensed under the **Apache License 2.0**.
+
+### How to Credit
+While you are free to use this framework for private or commercial bots, I require explicit credit. Please include a link to this repository or a mention of "Beacon" in:
+1. Your project's **README** or documentation.
+2. Your bot's **info/credits command** (for example `/about` or `/help`).
+
+*Example: "Built with [__Beacon__](https://github.com/smite-codes/beacon)"*

discord_beacon-3.0.0/README.md

@@ -0,0 +1,172 @@
+<div align="center">
+
+# Beacon
+
+</div>
+
+<p align="center">
+  <a href="https://pypi.org/project/discord-beacon/">
+    <img src="https://img.shields.io/pypi/v/beacon?style=for-the-badge&logo=pypi&color=blue" />
+  </a>
+  <a href="https://www.python.org/">
+  <img src="https://img.shields.io/badge/python-3.12+-yellow?style=for-the-badge&logo=python&logoColor=white" />
+</a>
+  <a href="https://github.com/smite-codes/beacon/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/smite-codes/beacon?style=for-the-badge&color=orange" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="#installing"><b>Install</b></a> •
+  <a href="#features"><b>Features</b></a> •
+  <a href="#comparison-with-sapphire-framework-and-bare-bones-discordpy"><b>Comparison</b></a> •
+  <a href="#implementation-example"><b>Quick Start</b></a> •
+  <a href="https://github.com/smite-codes/beacon/issues"><b>Report Bug</b></a>
+</p>
+
+Beacon is an **Unopinionated Framework** for discord.py which allows you to initialize a production-ready Discord bot in just 4 lines of code. It is designed to streamline the development of scalable Discord applications by automating the process of registering commands and simplify the process of creating them, diagnosing the bot, and various other utilities such as a paginator helper and "Private View" helpers which let only the user who initiated the interaction to interact with the components like buttons.
+
+A **Dopamine Studios** product.
+
+---
+## Installing
+
+**Use Python 3.12 or higher:**
+
+```Linux/MacOS
+# Linux/MacOS
+python3 -m pip install -U discord-beacon
+```
+```Windows
+# Windows
+py -3 -m pip install -U discord-beacon
+```
+## Features
+
+### 1. Smart Command Syncing
+
+The framework includes a Command Registry that compares local command states with remote Discord API states. This ensures that global and guild-specific slash commands are only synced when changes are detected, preventing unnecessary API overhead and rate-limit triggers.
+
+### 2. Beacon Commands decorator with Preconditions
+The `@beacon_commands.command` decorator replaces the standard discord.py version, allowing you to define permissions and cooldowns in a single line.
+
+* **Simplified Syntax:** Define name, description, permissions, and cooldowns within one decorator.
+* **Implicit Global Cooldown:** Every command is protected by the bot's global rate limit by default.
+* **Group Support:** Use `beacon_commands.Group` to apply permissions or cooldowns to an entire category of subcommands at once.
+
+```python
+from beacon import beacon_commands
+
+@beacon_commands.command(
+    name="ban",
+    permissions_preset="moderator",
+    global_cooldown=True
+)
+async def ban_member(interaction: discord.Interaction, member: discord.Member):
+    await member.ban()
+    await interaction.response.send_message(f"{member.display_name} has been banned.")
+```
+
+### 3. Precondition Decorators
+If you prefer using standard `app_commands`, you can use the standalone `@preconditions` decorators to enforce rules dynamically.
+
+* **Permission Presets:** Use pre-defined roles like `"admin"`, `"moderator"`, or `"support"` instead of manual permission bitfields.
+* **Advanced Logic:** Includes `has_permissions_any` (pass if user has one of many) and `has_permissions` (must have all).
+* **Smart Rate Limiting:** Easily implement command-specific or bot-wide global cooldowns to prevent spam.
+
+| Preset | Required Permissions |
+| :--- | :--- |
+| `"bot_owner"` | Restricts usage to the bot owner/team owners. |
+| `moderator` | Manage Messages, Kick Members, Ban Members |
+| `admin` | Administrator |
+| `giveaways` | Manage Guild, Manage Messages |
+| `automation` | Manage Guild, Manage Messages, Manage Channels |
+| `manager` | Manage Guild, Manage Roles, Manage Channels |
+| `support` | Manage Messages, Read Message History |
+| `security` | View Audit Log, Moderate Members |
+| `community` | Manage Expressions, Manage Threads, Create Public Threads |
+| `technical` | Manage Webhooks, Manage Guild |
+
+### 4. In-Discord Owner Dashboard
+
+No need for terminal access/SSH. This simple to use and feature-rich dashboard for bot owners allows you to unload/reload cogs on the fly, restart the bot, or check logs, accessed using `/od`. This allows bot owner(s) to manage, diagnose the bot right within Discord itself. This dashboard allows the bot to run idefinitely without restarts:
+
+* **Cog Management:** Dynamic loading, unloading, and uploading/replacing of cogs.
+* **Power State:** Remote shutdown and process-level restarts.
+* **Logs:** Real-time retrieval of log files via the Discord UI.
+* **Manual Command Syncs:** Sync commands manually globally or within only the current guild.
+### 5. Diagnostics
+
+The built-in `Diagnostics` "cog" (module) provides real-time monitoring of the bot's health, including:
+
+* **Latency:** High precision API, Heartbeat, and Round-trip latency monitoring.
+* **Resource Utilization:** CPU and RAM usage tracking via `psutil`.
+* **Graphs:** Generate graphs for the bot's latency for visual performance auditing.
+* **Host Device Metrics:** Integration with system sensors to report host location and battery status, if available.
+
+### 6. Built-in Logging Backend
+
+* A robust Logging Manager utilizing `aiosqlite` that can be plugged into any feature of your bot to implement a logging system, such as for mod logs, action logs, etc.
+
+---
+
+### Comparison (with Sapphire Framework and standard discord.py)
+
+| Feature                                                |     Beacon      |      Sapphire (js/ts)       |           discord.py            |
+|:-------------------------------------------------------|:---------------------------:|:---------------------------:|:-------------------------------:|
+| **Easy Setup**                                         | **✅ <br/>(minimal boilerplate)** | **❌** <br/>(Lots of boilerplate) |              **❌**              |
+| **Preconditions Support**                              |            **✅**            |            **✅**            |              **❌**              |
+| **Presets for Permission Checks<br/>in Preconditions** |            **✅**            |             **❌**            |              **❌**              |
+| **No tantrums over different structure**               |            **✅**            |            **❌**            |              **✅**              |
+| **Python's ease of use**                               |            **✅**            |            **❌**            |              **✅**              |
+| **Smart Commands Sync**                                |       **✅<br/>(Built-in)**       |   **✅** <br/>(Through plugins)   |  **❌** <br/>(not included/standard)  |
+| **In-Discord Dashboard**                               |      **✅ <br/>(Built-in)**       |            **❌**            |              **❌**              |
+| **Latency Graphs**                                     |      **✅ <br/>(Built-in)**       |            **❌**            |              **❌**              |
+| **Scalability***                                       |            **✅**            |            **✅**            |              **✅**              |
+| **Fast Iteration**                                     |            **✅**            |            **❌**            |              **❌**              |
+| **Strict TypeScript Rules**                            |            **❌**            |            **✅**            |              **❌**              |
+| **Built-in Resource Monitoring**                       |            **✅**            |            **❌**            |              **❌**              |
+| **Is it JS, tho?**                                     |            **❌**            |            **✅**            |              **❌**              |
+| **Wins Imaginary Benchmarks**                          |            **❌**            |            **✅**            |              **❌**              |
+
+<sup>*Scalability refers to ability to run without problems when the bot is in tens of thousands of servers or more. While it's a common myth that "Python is bloated", that's not true in the context of Discord bots. The real bottleneck in popular Discord bots always comes down to network, not code execution time or memory usage.</sup>
+
+
+---
+
+## Implementation Example
+
+To initialize a bot using the Beacon, follow the following example:
+
+```python
+import discord
+from beacon import Bot
+
+bot = Bot(command_prefix="?", cogs_path="your cogs/modules folder path here*", logging_path="path to .sqlite, .db, or .db3 file; only define if you want to use this logging backend.", default_diagnostics=True, intents=discord.Intents.default()) # If no cogs folder is defined, it will default to "cogs". If no logging path, logging will be disabled.
+
+bot.run("YOUR_BOT_TOKEN_HERE")
+```
+<sub>*Note: All .py files will be attempted to be loaded in the folder. It's recommended to only use the defined path for cogs/extensions/modules.</sub>
+
+---
+
+## Requirements
+
+* `discord.py`
+* `aiosqlite`
+* `psutil`
+* `Pillow`
+* `geocoder`
+
+---
+
+## License & Attribution
+
+Beacon is licensed under the **Apache License 2.0**.
+
+### How to Credit
+While you are free to use this framework for private or commercial bots, I require explicit credit. Please include a link to this repository or a mention of "Beacon" in:
+1. Your project's **README** or documentation.
+2. Your bot's **info/credits command** (for example `/about` or `/help`).
+
+*Example: "Built with [__Beacon__](https://github.com/smite-codes/beacon)"*

discord_beacon-3.0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "discord-beacon"
+version = "3.0.0"
+authors = [{name = "ismite"}]
+description = "Initialise a production-ready Discord.py bot in just 4 lines of code. Smart and automated command syncing, preconditions (and its presets), easy-to-use in-Discord dashboard, and more. A Dopamine Studios project."
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "discord.py>=2.6.4",
+    "aiosqlite",
+    "psutil",
+    "pillow",
+    "geocoder"
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"beacon.ext" = ["*.ttf"]

discord_beacon-3.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

discord_beacon-3.0.0/src/beacon/__init__.py

@@ -0,0 +1,3 @@
+from .bot import Bot
+from .utils import now_plus_seconds_unix, duration_to_seconds, PrivateLayoutView, PrivateView, ViewPaginator, LayoutViewPaginator, mod_check, prefix_mod_check
+from .core import beacon_commands, preconditions