Merge pull request #249 from davidhozic/develop

Documentation (#248)
davidhozic · Dec 29, 2022 · 88f4d6f · 88f4d6f
2 parents da3d195 + 364902c
commit 88f4d6f
Show file tree

Hide file tree

Showing 16 changed files with 118 additions and 160 deletions.
diff --git a/Examples/Automatic Generation/autochannel.py b/Examples/Automatic Generation/autochannel.py
@@ -8,16 +8,11 @@ async def main():
             token="SomeToken",
             is_user=False,
             servers=[
-                daf.GUILD(
-                    snowflake=123456789,
-                    messages=[
-                        daf.TextMESSAGE(
-                            None, timedelta(seconds=5), "Hello World",
-                            channels=daf.message.AutoCHANNEL("shill", exclude_pattern="shill-[7-9]")
-                        )
-                    ],
-                    logging=True
-                )
+                daf.GUILD(snowflake=123456789,
+                          messages=[
+                                daf.TextMESSAGE(None, timedelta(seconds=5), "Hello World", channels=daf.message.AutoCHANNEL("shill", exclude_pattern="shill-[7-9]"))
+                            ],
+                          logging=True) 
             ]
         )
     )

diff --git a/Examples/Automatic Generation/autoguild.py b/Examples/Automatic Generation/autoguild.py
@@ -8,16 +8,14 @@
         token="SomeToken",
         is_user=False,
         servers=[
-            daf.guild.AutoGUILD(
-                include_pattern="NFT-Dragons", # Regex pattern of guild names that should be included
-                exclude_pattern="NonFunctionalTesticle",   # Regex pattern of guild names that should be excluded
-                remove_after=None, # Never stop automatically managing guilds
-                messages=[ # Pre-include messages
-                    daf.message.TextMESSAGE(None, timedelta(seconds=5), "Buy our NFT today!",daf.guild.AutoCHANNEL("shill", "promo", timedelta(seconds=60)))
-                ], 
-                logging=True, # The generated GUILD objects will have logging enabled
-                interval=timedelta(hours=1) # Scan for new guilds in a period of one hour
-            )
+            daf.guild.AutoGUILD( include_pattern="NFT-Dragons", # Regex pattern of guild names that should be included
+                                 exclude_pattern="NonFunctionalTesticle",   # Regex pattern of guild names that should be excluded
+                                 remove_after=None, # Never stop automatically managing guilds
+                                 messages=[
+                                    daf.message.TextMESSAGE(None, timedelta(seconds=5), "Buy our NFT today!", daf.message.AutoCHANNEL("shill", "promo", timedelta(seconds=60)))
+                                 ], 
+                                 logging=True, # The generated GUILD objects will have logging enabled
+                                 interval=timedelta(hours=1) ) # Scan for new guilds in a period of one hour
         ]
     )
 ]

diff --git a/Examples/Automatic Generation/find_promo_channels.py b/Examples/Automatic Generation/find_promo_channels.py
diff --git a/Examples/Dynamic Modification/main_add_object.py b/Examples/Dynamic Modification/main_add_object.py
@@ -6,19 +6,13 @@
 import daf
 
 
-# Create a list in which we will automatically add guilds
-allowed_strings = {"shill", "advert", "promo"}
-data_to_shill = (     # Example data set
-                "Hello World", 
-                daf.discord.Embed(title="Example Embed",
-                         color=daf.discord.Color.blue(),
-                         description="This is a test embed")
-                )
-
 async def user_task():
     # Returns the client to send commands to discord, for more info about client see https://docs.pycord.dev/en/master/api.html?highlight=discord%20client#discord.Client
     account = daf.ACCOUNT(token="ASDASJDAKDK", is_user=False)
+
     guild = daf.GUILD(snowflake=123456)
+
+    data_to_shill = ( "Hello World", daf.discord.Embed(title="Example Embed", color=daf.discord.Color.blue(), description="This is a test embed") )
     text_msg = daf.TextMESSAGE(None, timedelta(seconds=5), data_to_shill, [12345, 6789], "send", timedelta(seconds=0))
 
     # Dynamically add account
@@ -36,4 +30,3 @@ async def user_task():
 ############################################################################################
 if __name__ == "__main__":
     daf.run(user_callback=user_task)  
-
diff --git a/Examples/Dynamic Modification/main_remove_object.py b/Examples/Dynamic Modification/main_remove_object.py
@@ -5,7 +5,7 @@
 import daf
 
 accounts = [
-    daf.ACCOUNT(
+    account := daf.ACCOUNT(
         token="SDSADSDA87sd87",
         is_user=False,
         servers=[
@@ -16,7 +16,7 @@
 
 
 async def user_task():
-    guild = accounts[0].servers[0]
+    guild = account.servers[0]
     await daf.remove_object(guild)
 
 

diff --git a/Examples/Dynamic Modification/main_update.py b/Examples/Dynamic Modification/main_update.py
@@ -11,19 +11,11 @@
 import daf
 
 
-
 message = daf.TextMESSAGE(None, timedelta(seconds=5), "Hello", [123455, 1425215])
 accounts = [
-    daf.ACCOUNT(
-        token="SKJDSKAJDKSJDKLAJSKJKJKGSAKGJLKSJG",
-        is_user=False,
-        servers=[
-            daf.GUILD(1234567, [
-                    message 
-                ]
-            )
-        ]
-    )
+    daf.ACCOUNT( token="SKJDSKAJDKSJDKLAJSKJKJKGSAKGJLKSJG",
+                 is_user=False,
+                 servers=[daf.GUILD(1234567, [message])] )
 ]
 
 
@@ -33,12 +25,7 @@ async def user_task():
     await message.update(end_period=timedelta(seconds=20), data="World")
     # Will now send "World" every 20 seconds
 
-    #########################################################################
-
-############################################################################################################################################################################
-
 
-############################################################################################
 if __name__ == "__main__":
     daf.run(user_callback=user_task, accounts=accounts)  
 
diff --git a/Examples/Logging/CSV files/main_rickroll.py b/Examples/Logging/CSV files/main_rickroll.py
@@ -19,19 +19,11 @@ def get(st):
     return item
 
 accounts = [
-    daf.ACCOUNT(
-        token="SDASKDKLSADJKLSDJ",
-        is_user=False,
-        servers=[
-            daf.GUILD(
-                snowflake=12345,
-                messages=[
-                    daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit", timedelta(seconds=5))
-                ],
-                logging=True
-            )
-        ]
-    )
+    daf.ACCOUNT( token="SDASKDKLSADJKLSDJ",
+                 is_user=False,
+                 servers=[ 
+                    daf.GUILD(12345, [daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit")], True) 
+                  ] )
 ]
 
 

diff --git a/Examples/Logging/JSON files/main_rickroll.py b/Examples/Logging/JSON files/main_rickroll.py
@@ -19,19 +19,11 @@ def get(st):
     return item
 
 accounts = [
-    daf.ACCOUNT(
-        token="SDASKDKLSADJKLSDJ",
-        is_user=False,
-        servers=[
-            daf.GUILD(
-                snowflake=12345,
-                messages=[
-                    daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit", timedelta(seconds=5))
-                ],
-                logging=True
-            )
-        ]
-    )
+    daf.ACCOUNT( token="SDASKDKLSADJKLSDJ",
+                 is_user=False,
+                 servers=[ 
+                    daf.GUILD(12345, [daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit")], True) 
+                  ] )
 ]
 
 

diff --git a/Examples/Logging/SQL Logging/rolls.py b/Examples/Logging/SQL Logging/rolls.py
@@ -19,19 +19,11 @@ def get(st):
     return item
 
 accounts = [
-    daf.ACCOUNT(
-        token="SDASKDKLSADJKLSDJ",
-        is_user=False,
-        servers=[
-            daf.GUILD(
-                snowflake=12345,
-                messages=[
-                    daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit", timedelta(seconds=5))
-                ],
-                logging=True
-            )
-        ]
-    )
+    daf.ACCOUNT( token="SDASKDKLSADJKLSDJ",
+                 is_user=False,
+                 servers=[ 
+                    daf.GUILD(12345, [daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit")], True) 
+                  ] )
 ]
 
 

diff --git a/Examples/Message Types/DirectMESSAGE/main_data_function.py b/Examples/Message Types/DirectMESSAGE/main_data_function.py
@@ -15,7 +15,18 @@ def get_data(parameter):
     return f"Parameter: {parameter}\nTimestamp: {l_time.day}.{l_time.month}.{l_time.year} :: {l_time.hour}:{l_time.minute}:{l_time.second}"
 
 accounts = [
-    daf.ACCOUNT(
+    daf.ACCOUNT( # ACCOUNT 1
+        "JJJKHSAJDHKJHDKJ",
+        False,
+        [
+            daf.USER(123456789,
+                     [        
+                        daf.DirectMESSAGE(None, timedelta(seconds=15), get_data(123)),  
+                     ],
+                     True)
+        ]
+    ),
+    daf.ACCOUNT( # ACCOUNT 2
         token="JJJKHSAJDHKJHDKJ",
         is_user=False,
         servers=[

diff --git a/Examples/Message Types/DirectMESSAGE/main_send_multiple.py b/Examples/Message Types/DirectMESSAGE/main_send_multiple.py
@@ -28,7 +28,18 @@
 )
 
 accounts = [
-    daf.ACCOUNT(
+    daf.ACCOUNT( # ACCOUNT 1
+        "JJJKHSAJDHKJHDKJ",
+        False,
+        [
+            daf.USER(123456789,
+                     [        
+                        daf.DirectMESSAGE(None, timedelta(seconds=15), ["Test", l_file1, l_file2, l_embed]),  
+                     ],
+                     True)
+        ]
+    ),
+    daf.ACCOUNT( # ACCOUNT 2
         token="JJJKHSAJDHKJHDKJ",
         is_user=False,
         servers=[

diff --git a/Examples/Message Types/TextMESSAGE/main_data_function.py b/Examples/Message Types/TextMESSAGE/main_data_function.py
@@ -15,7 +15,18 @@ def get_data(parameter):
     return f"Parameter: {parameter}\nTimestamp: {l_time.day}.{l_time.month}.{l_time.year} :: {l_time.hour}:{l_time.minute}:{l_time.second}"
 
 accounts = [
-    daf.ACCOUNT(
+    daf.ACCOUNT( # ACCOUNT 1
+        "JJJKHSAJDHKJHDKJ",
+        False,
+        [
+            daf.GUILD(123456789,
+                     [        
+                        daf.TextMESSAGE(None, timedelta(seconds=15), get_data(123), [12345, 6789]),  
+                     ],
+                     True)
+        ]
+    ),
+    daf.ACCOUNT( # ACCOUNT 2
         token="JJJKHSAJDHKJHDKJ",
         is_user=False,
         servers=[

diff --git a/Examples/Message Types/TextMESSAGE/main_send_multiple.py b/Examples/Message Types/TextMESSAGE/main_send_multiple.py
@@ -28,7 +28,18 @@
 )
 
 accounts = [
-    daf.ACCOUNT(
+    daf.ACCOUNT( # ACCOUNT 1
+        "JJJKHSAJDHKJHDKJ",
+        False,
+        [
+            daf.GUILD(123456789,
+                     [        
+                        daf.TextMESSAGE(None, timedelta(seconds=15), ["Test", l_file1, l_file2, l_embed], [12345, 6789]),  
+                     ],
+                     True)
+        ]
+    ),
+    daf.ACCOUNT( # ACCOUNT 2
         token="JJJKHSAJDHKJHDKJ",
         is_user=False,
         servers=[

diff --git a/Examples/Message Types/VoiceMESSAGE/main_data_function.py b/Examples/Message Types/VoiceMESSAGE/main_data_function.py
@@ -13,11 +13,22 @@ def get_data(param1, param2):
 
 
 accounts = [
-    daf.ACCOUNT(
+    daf.ACCOUNT( # ACCOUNT 1
+        "JJJKHSAJDHKJHDKJ",
+        False,
+        [
+            daf.GUILD(123456789,
+                     [        
+                        daf.VoiceMESSAGE(None, timedelta(seconds=15), get_data(123), [12345, 6789]),  
+                     ],
+                     True)
+        ]
+    ),
+    daf.ACCOUNT( # ACCOUNT 2
         token="JJJKHSAJDHKJHDKJ",
         is_user=False,
         servers=[
-            daf.USER(
+            daf.GUILD(
                 snowflake=123456789, # ID of server (guild) or a discord.Guild object
                 messages=[         # List MESSAGE objects 
                     daf.VoiceMESSAGE(

diff --git a/Examples/Message Types/VoiceMESSAGE/main_stream_audio.py b/Examples/Message Types/VoiceMESSAGE/main_stream_audio.py
@@ -9,11 +9,22 @@
 ############################################################################################
 
 accounts = [
-    daf.ACCOUNT(
+    daf.ACCOUNT( # ACCOUNT 1
+        "JJJKHSAJDHKJHDKJ",
+        False,
+        [
+            daf.GUILD(123456789,
+                     [        
+                        daf.VoiceMESSAGE(None, timedelta(seconds=15), daf.AUDIO("VoiceMessage.mp3"), [12345, 6789]),  
+                     ],
+                     True)
+        ]
+    ),
+    daf.ACCOUNT( # ACCOUNT 2
         token="JJJKHSAJDHKJHDKJ",
         is_user=False,
         servers=[
-            daf.USER(
+            daf.GUILD(
                 snowflake=123456789, # ID of server (guild) or a discord.Guild object
                 messages=[         # List MESSAGE objects 
                     daf.VoiceMESSAGE(