Version bump, linting, refactoring (#138)

* Version bump, TODO, linting

* Smaller Improvements

Author: davidhozic

.github/workflows/docs.yml

@@ -16,7 +16,7 @@ on:
         - warning
         - debug 
 
-jobs: 
+jobs:
   upload:
     runs-on: ubuntu-latest
 
@@ -32,19 +32,5 @@ jobs:
     - name:  build
       working-directory: docs
       run:   make clean html
-    
 
-    - name: GitHub Pages
-      # You may pin to the exact commit or the version.
-      # uses: crazy-max/ghaction-github-pages@eb08c35b9fab86751edfff4e55cd5cde35ff0e52
-      uses: crazy-max/[email protected]
-      with:
-        # Git domain (default github.com)
-        #domain: # optional, default is github.com
-        # Git branch where assets will be deployed
-        #target_branch: # optional, default is gh-pages
-        # Create incremental commit instead of doing push force
-        # Build directory to deploy
-        build_dir: docs/build/html
-        # Allow Jekyll to build your site
-        jekyll: False
+# TODO: Upload to FTP

Examples/Message Types/VoiceMESSAGE/main_data_function.py

@@ -21,6 +21,7 @@ def get_data(param1, param2):
                                                                 # If start period is defined, it dictates the maximum limit of randomized period
                               data=get_data(1, 2),              # Data parameter
                               channels=[123456789],             # List of channel ids or discord.VoiceChannel objects
+                              volume=50,                        # The volume (0-100%) at which to play the audio
                               start_now=True                    # Start sending now (True) or wait until period
                               ),  
         ],

Examples/Message Types/VoiceMESSAGE/main_stream_audio.py

@@ -14,6 +14,7 @@
                                                                 # If start period is defined, it dictates the maximum limit of randomized period
                               data=some_audio_file,             # Data parameter
                               channels=[123456789],             # List of channel ids or discord.VoiceChannel objects
+                              volume=50,                        # The volume (0-100%) at which to play the audio
                               start_now=True                    # Start sending now (True) or wait until period
                               ),  
         ],

docs/source/changelog.rst

@@ -7,7 +7,7 @@ Changelog
     The library first started as a single file script that I didn't make versions of.
     When I decided to turn it into a library, I've set the version number based on the amount of commits I have made since the start.
 
-v1.9.5
+v2.0
 ----------------------
 - New cool looking web documentation (the one you're reading now)
 - Added volume parameter to :ref:`VoiceMESSAGE`

docs/source/conf.py

@@ -22,7 +22,7 @@
 project = 'Discord Advert Framework'
 copyright = '2022, David Hozic'
 author = 'David Hozic'
-version = ""
+version = "v2.0.0"
 
 with open("../../src/framework/__init__.py", "r", encoding="utf-8") as init_file:
     match = re.search(r"(?<=\|).*Version.*(?=\|)", init_file.read())

docs/source/index.rst

@@ -3,11 +3,6 @@ DAF (|version|)
 =========================================================
 The Discord advertisement framework is a  **shilling tool** that allows easy advertising on Discord.
 
-.. warning::
-        **Version v1.9.5 is not yet released** or even ready. The **latest version is v1.9**.
-
-        Anything that has a **"Changed in v1.9.5"** or **"Added in v1.9.5"** is **not yet available**!
-
 
 Links
 ----------------------

setup.py

@@ -12,7 +12,7 @@
 
 __metadata__ = \
 {
-    "version" :  "1.9.2",
+    "version" :  "2.0.0",
     "requirements" : req,
     "minimum_py_version" :  "3.8",
 }

src/framework/__init__.py

@@ -1,12 +1,7 @@
 """
-    ==============================================
-    DISCORD ADVERTISEMENT FRAMEWORK (DAF)
-    ==============================================
-   +----------+-----------------------------------+
-   | Author   |   David Hozic                     |
-   | Copyright|   Copyright (c) 2022 David Hozic  |
-   | Version  |   v1.9.5                          |          
-   +----------+-----------------------------------+
+Discord Advertisement Framework
+
+Version 2.0
 """
 import _discord as discord
 from .client import *
@@ -17,9 +12,4 @@
 from .message import *
 from .tracing import *
 from .sql import *
-from .exceptions import *
-
-#-----------------
-# TODO:
-#-----------------
-#  Update Examples
+from .exceptions import *

src/framework/core.py

@@ -239,7 +239,7 @@ def remove_object(data):
 
 async def _update(obj: Any, *, init_options: dict = {}, **kwargs):
         """
-        .. versionadded:: v1.9.5
+        .. versionadded:: v2.0
 
         Used for changing the initialization parameters the obj was initialized with.
         
@@ -344,11 +344,11 @@ def run(token : str,
     """
 
     guild.GLOBALS.server_log_path = server_log_output               # Logging folder
-    tracing.m_use_debug = debug                                     # Print trace messages to the console for debugging purposes
     GLOBALS.temp_server_list = server_list                          # List of guild objects to iterate thru in the advertiser task
     GLOBALS.sql_manager = sql_manager                               # SQL manager object
     GLOBALS.is_user = is_user                                       # Is the token from an user account
     if user_callback is not None:
         GLOBALS.user_callback = user_callback()                     # Called after framework has started
-
+    
+    tracing.initialize(debug)                                       # Print trace messages to the console for debugging purposes
     client._initialize(token, bot=not is_user, intents=intents)

src/framework/dtypes.py

@@ -257,11 +257,13 @@ def __init__(self, filename: str) -> None:
             except FileNotFoundError:
                 raise DAFNotFoundError(f"The file {self.url} could not be found.", DAF_FILE_NOT_FOUND)
 
-
-    @property
-    def filename(self):
+    def to_dict(self):
         """
-        Returns the filename of the file or the name of a youtube video with the link
+        Returns dictionary representation of this data type.
+
+        .. versionchanged:: v2.0
+
+            Changed to method ``to_dict`` from property ``filename``
         """
         if self.stream:
             return {