Merge pull request #137 from davidhozic/develop

v2.0.0

Author: davidhozic

.github/workflows/docs.yml

@@ -17,52 +17,20 @@ on:
         - debug 
 
 jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: make
-      run: make
-    - name: make check
-      run: make check
-    - name: make distcheck
-      run: make distcheck
-  
-  
   upload:
     runs-on: ubuntu-latest
+    
     steps:
     - uses:  actions/checkout@v3
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -U -r requirements.txt
+        pip install -U -r docs/requirements.txt
+    
     - name:  build
       working-directory: docs
       run:   make clean html
-    - name: ftp-clean
-      # You may pin to the exact commit or the version.
-      # uses: taylorgibb/ftp-clean@37c34052bd2170bcab847bf8b61df5f4ff526093
-      uses: taylorgibb/[email protected]
-      with:
-        # FTP host
-        host: ${{ secrets.WEB_FTP_SERVER }}
-        # FTP user
-        user:  ${{ secrets.WEB_FTP_USERNAME }}
-        # FTP password
-        password: ${{ secrets.WEB_FTP_PASSWORD }}
-        # Files and directories which should be excluded from being removed.
-        exclude: "stats"
 
-    - name: FTP Deploy
-      # You may pin to the exact commit or the version.
-      # uses: SamKirkland/FTP-Deploy-Action@d0aa83872616587eb552bc831bb9166b3f9c5ad5
-      uses: SamKirkland/[email protected]
-      with:
-        # ftp server
-        server: ${{ secrets.WEB_FTP_SERVER }}
-        # ftp username
-        username: ${{ secrets.WEB_FTP_USERNAME }}
-        # ftp password
-        password: ${{ secrets.WEB_FTP_PASSWORD }}
-        # Server port to connect to (read your web hosts docs)
-    
-  
+# TODO: Upload to FTP

.gitignore

@@ -1,3 +1,5 @@
 **/__pycache__/**
 settings.json
-dist/**
+dist/**
+test**
+build**

Examples/Additional Application Layer Example/Coffee/main_coffee.py

@@ -12,12 +12,12 @@
 
 servers = [
     fw.GUILD(
-        guild_id=123456789,
-        messages_to_send=[
+        snowflake=123456789,
+        messages=[
 
-            fw.TextMESSAGE(start_period=None, end_period=10, data=app.app.get_data(), channel_ids=[123456789], mode="send", start_now=True)
+            fw.TextMESSAGE(start_period=None, end_period=10, data=app.app.get_data(), channels=[123456789], mode="send", start_now=True)
         ],
-        generate_log=True
+        logging=True
     )
 ]
 

Examples/Additional Application Layer Example/Scheduled messages/BOT/main_obv.py

@@ -250,11 +250,11 @@ async def main():
 # Create the server list
 servers = [
         fw.GUILD (
-            guild_id=guild["SERVER-ID"], 
-            messages_to_send= [
+            snowflake=guild["SERVER-ID"], 
+            messages= [
                 fw.TextMESSAGE(None, 1, get_data(ch_id), [ch_id], "send", True) for ch_id in guild["CHANNEL-IDs"]
             ],
-            generate_log=True
+            logging=True
         ) for guild in conf.WHITELISTED_GUILDS   
 ]
 

Examples/Dynamic Modification/main.py

@@ -0,0 +1,61 @@
+"""
+The following example automatically generates the shilling list if the channel name matches
+any of the allowed_strings words.
+
+It then dynamically adds an object, and later calls .update() method to change the initialization parameters
+passed at the start.
+"""
+
+import asyncio
+import  framework as fw
+from framework import trace
+
+
+# Create a list in which we will automatically add guilds
+allowed_strings = {"shill", "advert", "promo"}
+data_to_shill = (     # Example data set
+                "Hello World", 
+                fw.EMBED(title="Example Embed",
+                         color=fw.EMBED.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
+    client = fw.get_client()  
+    for guild in client.guilds:  # Iterate thru all the guilds where the bot is in
+        await fw.add_object(
+            fw.GUILD(guild.id, logging=True)
+        )
+
+        # Find channels that match allowed_strings
+        channels = []
+        for channel in guild.text_channels: # Iterate thru all the text channels in the guild
+            if any([x in channel.name for x in allowed_strings]): # Check if any of the strings in allowed_strings are in the channel name
+                channels.append(channel)
+
+        text_msg = fw.TextMESSAGE(None, 15, data_to_shill, channels, "send", True)
+
+        # Dynamically add a message to the list
+        await fw.add_object(text_msg, guild.id)
+
+    #########################################################################
+    #   Dynamic text message modification of the shill data and send period
+    #########################################################################
+    await asyncio.sleep(10)
+    trace("Updating the TextMESSAGE object")
+    # Update the object
+    await text_msg.update(data="Updated Data", end_period=60) 
+
+    trace("Now shilling 'Updated Data' with period of 60 seconds")
+    #########################################################################
+
+############################################################################################################################################################################
+
+
+############################################################################################
+if __name__ == "__main__":
+    fw.run(token="OOFOAFO321o3oOOAOO$Oo$o$@O4242",
+           user_callback=user_task)  
+    

Examples/Examples.zip

@@ -19,11 +19,11 @@ def get(st):
 
 servers = [
     fw.GUILD(
-        guild_id=12345,
-        messages_to_send=[
+        snowflake=12345,
+        messages=[
             fw.TextMESSAGE(None, 5, get(rolls.copy()), [12345], "edit", True)
         ],
-        generate_log=True
+        logging=True
     )
 ]
 

Examples/Logging/JSON files/main_rickroll.py

@@ -19,11 +19,11 @@ def get(st):
 
 servers = [
     fw.GUILD(
-        guild_id=12345,
-        messages_to_send=[
+        snowflake=12345,
+        messages=[
             fw.TextMESSAGE(None, 5, get(rolls.copy()), [12345], "edit", True)
         ],
-        generate_log=True
+        logging=True
     )
 ]
 

Examples/Logging/SQL Logging/main_rickroll.py

@@ -15,8 +15,8 @@ def get_data(parameter):
 
 guilds = [
     framework.USER(
-        user_id=123456789,                                 # ID of server (guild)
-        messages_to_send=[                                  # List MESSAGE objects 
+        user_id=123456789,                                 # ID of server (guild) or a discord.Guild object
+        messages=[                                  # List MESSAGE objects 
             framework.DirectMESSAGE(
                               start_period=None,            # If None, messages will be send on a fixed period (end period)
                               end_period=15,                # If start_period is None, it dictates the fixed sending period,
@@ -29,7 +29,7 @@ def get_data(parameter):
                               start_now=True                # Start sending now (True) or wait until period
                               ),  
         ],
-        generate_log=True                                   ## Generate file log of sent messages (and failed attempts) for this user
+        logging=True                                   ## Generate file log of sent messages (and failed attempts) for this user
     )
 ]
 

Examples/Message Types/DirectMESSAGE/main_data_function.py

@@ -41,8 +41,8 @@
 ############################################################################################
 guilds = [
     fw.USER(
-        user_id=123456789,                                 # ID of server (guild)
-        messages_to_send=[                                  # List MESSAGE objects
+        user_id=123456789,                                 # ID of server (guild) or a discord.Guild object
+        messages=[                                  # List MESSAGE objects
             fw.DirectMESSAGE(
                               start_period=None,            # If None, messages will be send on a fixed period (end period)
                               end_period=15,                # If start_period is None, it dictates the fixed sending period,
@@ -65,7 +65,7 @@
                               start_now=True
                               ),
         ],
-        generate_log=True                                   ## Generate file log of sent messages (and failed attempts) for this user
+        logging=True                                   ## Generate file log of sent messages (and failed attempts) for this user
     )
 ]