Merge branch 'main' of https://github.com/Dispy-inc/Dispy

Author: James

docs/README.md

@@ -26,14 +26,16 @@ Dispy lets bot developers focus on their ideas and the structure of their bots i
 ***
 
 * Getting Started
-  * [**Introduction**](documentation/readme/introduction.md): Installation and importation
-  * [**Setup your bot on discord**](documentation/readme/setup-your-bot-on-discord.md): Getting your bot token and invite link
+  * [Introduction](documentation/readme/introduction.md): Installation and importation
+  * [Setup your bot on discord](documentation/readme/setup-your-bot-on-discord.md): Getting your bot token and invite link
+  * [Examples](documentation/examples.md): Get familiarize with Dispy
 * Contribute
   * [Adding an API function](informations/contribute/adding-an-api-function.md): Learn how to add any missing functions to Dispy
-* Versions ([changelogs](informations/changelogs/))
+* Versions ([Changelogs](informations/changelogs/))
   * [0.1.0.7](informations/changelogs/0.1.0.7.md) (Work in progress)
   * [0.1.0.6](informations/changelogs/0.1.0.6.md)
   * [0.1.0.5](informations/changelogs/0.1.0.5.md)
   * [0.1.0](informations/changelogs/0.1.0.md)
   * [0.0.1](informations/changelogs/0.0.1.md)
 * [Roadmap](informations/roadmap.md): See the progression of Dispy
+* [Support](informations/support.md): Know if your project can be made using Dispy

docs/SUMMARY.md

@@ -5,14 +5,14 @@
 * [Getting started](README.md)
   * [Installation](documentation/readme/introduction.md)
   * [Create a bot](documentation/readme/setup-your-bot-on-discord.md)
-* [Support](documentation/support.md)
 * [Functions](documentation/functions/README.md)
   * [\*](documentation/functions/undefined.md)
   * [Message](documentation/functions/message.md)
 * [Events](documentation/events/README.md)
   * [Supported Events](documentation/events/supported-events.md)
 * [Courses](documentation/wiki/README.md)
   * [Ready print](documentation/wiki/ready-print.md)
+* [Examples](documentation/examples.md)
 
 ## Informations
 
@@ -25,3 +25,4 @@
   * [0.1.0](informations/changelogs/0.1.0.md)
   * [0.0.1](informations/changelogs/0.0.1.md)
 * [Roadmap](informations/roadmap.md)
+* [Support](informations/support.md)

docs/documentation/examples.md

@@ -0,0 +1,86 @@
+---
+icon: copy
+---
+
+# Examples
+
+***
+
+{% hint style="danger" %}
+These examples assume that you have the **Message Content** privileged intent enabled. Follow step 4 on the [Create a bot](readme/setup-your-bot-on-discord.md) guide.
+{% endhint %}
+
+### Base Template
+
+This is how the base code of your bot should like, but I recommend hiding the token better.
+
+```python
+from dispy import Bot
+
+token = 'your_token'
+bot = Bot(token)
+
+@bot.once('READY')
+def on_ready():
+   print('READY')
+
+bot.run()
+```
+
+### Help Command
+
+To test your command, simply send `!help` in a channel that the bot has access to.
+
+```python
+from dispy import Bot
+from dispy.types import (
+   Message,
+   User
+)
+
+token = 'your_token'
+bot = Bot(token)
+
+@bot.once('READY')
+def on_ready():
+   print('READY')
+   
+@bot.on('MESSAGE_CREATE')
+def on_message(msg: Message, user: User):
+   if msg.content == '!help':
+      msg.reply('My commands are:\n- !help - List the commands')
+
+bot.run()
+```
+
+### Embed Example
+
+This is a basic example of the embed functionality, to see your embed, simply send `!help` in a channel that the bot has access to.
+
+```python
+from dispy import Bot, EmbedBuilder
+from dispy.types import (
+   Message,
+   User
+)
+
+token = 'your_token'
+bot = Bot(token)
+
+@bot.once('READY')
+def on_ready():
+    print('READY')
+   
+@bot.on('MESSAGE_CREATE')
+def on_message(msg: Message, user: User):
+    if msg.content == '!help':
+        helpCommand = (EmbedBuilder()
+            .setTitle('Commands List')
+            .setColor('blue')
+            .addField('!help', 'List the commands')
+        )
+        msg.reply(embeds=helpCommand)
+
+bot.run()
+```
+

docs/documentation/wiki/ready-print.md

@@ -23,9 +23,8 @@ This page is under construction!
 
 Print when the bot is online on discord. Don't forgot to replace 'your\_token' with your actual token.
 
-```python
-from dispy import Bot
-
+<pre class="language-python"><code class="lang-python"><strong>from dispy import Bot
+</strong>
 token = 'your_token'
 bot = Bot(token)
 
@@ -34,4 +33,4 @@ def on_ready(msg):
    print('READY')
 
 bot.run()
-```
+</code></pre>

docs/informations/changelogs/0.1.0.7.md

@@ -8,6 +8,8 @@ Hello! This version is meant to make dispy more intuitive and simple to use. The
 
 I've made importing the library more clean and more optimized. All the types need to be imported from `dispy.types` as for now and creating a bot is made with `from dispy import Bot`.
 
+And i'm working on slash commands, it will be really cool to use!
+
 ### Test It
 
 To install this work in progress version, you need to follow theses commands:
@@ -16,7 +18,7 @@ To install this work in progress version, you need to follow theses commands:
 pip install git+https://github.com/Dispy-inc/Dispy.git
 ```
 
-{% hint style="danger" %}
+{% hint style="warning" %}
 This is an experimental version, you may encounter bugs.
 {% endhint %}
 
@@ -28,23 +30,22 @@ This is an experimental version, you may encounter bugs.
 * Snowflakes (IDs) now are represent as STR and INT, so you can compared them (e.g. is equal) with STR and INT values.
 * ISO timestamp are now automatically converted to epoch timestamp, now dispy will only use this kind of timestamp because it is easier to manipulate.
 * Added a caching system used by slash commands, it can store informations so it isn't define every executions.
-* _<mark style="background-color:orange;">Started working on slash commands.</mark>_
-
-#### Changes
-
-* Importing dispy is now way more clean.
+* Added `.getDict()` to the DictWrapper, so you can finally use `json.dumps()`.
 
 **Fix**
 
 * Editing a message now return a message object.
 * Fixed an issue with DictWrapper, which made if the debug mode was disable, it will failed if there is an extra field.
-* Made tokens and headers attributes private so eval cannot get them (Never use it anyway).
 
 **Removed**
 
 * Pydantic dependency.
 * TokenReader() was removed :'(
 
+#### Changes
+
+* Importing dispy is now way more clean.
+
 ### How to update my code?
 
 #### Timestamps

docs/informations/contribute/adding-an-api-function.md

@@ -22,15 +22,15 @@ If you don't know how to make a pull request (Demand to change the code), you ma
 
 {% stepper %}
 {% step %}
-#### Research
+**Research**
 
 Before you code a new function for Dispy, you need to know exactly how to do it.
 
 In the [documentation](https://discord.com/developers/docs/intro) of discord, you can find every possible API requests, e.g. [Request to create a message](https://discord.com/developers/docs/resources/message#create-message). You will need theses informations to continue.
 {% endstep %}
 
 {% step %}
-#### Amount
+**Amount**
 
 In Dispy, your function can be in multiple place, e.g. to create a message:
 
@@ -42,15 +42,15 @@ An API function need to be present on types that has the necessary informations
 {% endstep %}
 
 {% step %}
-#### Where
+**Where**
 
 The API function for the bot object are located in **dispy.modules.**_**rest\_api.py**_.
 
 For an object (e.g. Message), they are located in **dispy.types** and the file which contain the definition of the object. If the object doesn't exist, follow this guide[^1].
 {% endstep %}
 
 {% step %}
-#### Introduction
+**Introduction**
 
 If the object doesn't have the `_api = None` argument, you need to add it at the end of all the type definition. With this you can call the \_\_request\_\_ object.
 
@@ -63,11 +63,11 @@ import asyncio
 {% endstep %}
 
 {% step %}
-#### Create the Function
+**Create the Function**
 
 When creating a function, you need to follow some rules to be sure your pull request will be accepted.
 
-* If the API request return something, it need to has a type object (If it doesn't exist, create it using this guide[^2]) or put 'None' if nothing is returned
+* If the API request return something, it need to has a type object (If it doesn't exist, create it using this guide[^1]) or put 'None' if nothing is returned
 * It need to be asynchronous.
 * It need to be using the internal function of Dispy (`result` & `__request__`)
 * The line using \_\_request\_\_ need to have the comment `# no_traceback` at the end.
@@ -102,7 +102,7 @@ def function(self, argument=None, **kwargs) -> result[<Type>]:
 3. And `<path>`, you replace by the API path given by the Discord documentation.
 
 {% hint style="danger" %}
-If your function need to has an argument called **"embeds"**, you need to define it manually inside your \_asynchronous function and give it inside the **run\_coroutine\_threadsafe**. Don't ask me why, ask asyncio.
+Some arguments will need to be passed through **run\_coroutine\_threadsafe**.
 {% endhint %}
 {% endstep %}
 
@@ -118,7 +118,3 @@ And you're done! Time to open a pull request
 [^1]: There is no guide yet.
 
     Ask the developer :)
-
-[^2]: There is no guide yet.
-
-    Ask the developer :)

docs/documentation/support.md renamed to docs/informations/support.md

@@ -15,6 +15,7 @@ Because dispy is very new, I made a support page so you can know if you can make
 
 * **SEND** | **EDIT** | **DELETE** | **REPLY** Message
 * **ADD** | **REMOVE SPECIFIED** Reaction
+* **KICK** | **BAN** | **TIMEOUT** User & Member (Can depend on the data)
 
 ### Supported Types