Merge pull request #182 from davidhozic/develop

davidhozic · web-flow · commit e3923c3ddf01 · 2022-09-04T12:51:59.000+02:00
SQL Dependancy fix, documentation
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,32 @@
+=========================================================
+DAF (v2.1.rc1)
+=========================================================
+.. image:: docs/source/images/logo.png
+    :width: 100
+    
+The Discord advertisement framework is a  **shilling tool** that allows easy advertising on Discord.
+
+----------------------
+Other information
+----------------------
+For more information see the project's `Webpage <https://daf.davidhozic.top>`_.
+
+----------------------
+Key features
+----------------------
+- Ability to run on **user** accounts (against discord's ToS) or **bot** accounts
+- Periodic advertisement to **Direct (Private) Messages**, **Text channels** and **Voice channels**
+- Advertising with either static data (text, embed, files, audio) or **dynamic data** (the data is obtained thru a function dynamically)
+- Logging of send attempts with **JSON** file logs or to a **SQL** server (Microsoft SQL Server only)
+- Ability to add additional application layers with help of asyncio
+- Easy to setup
+
+.. caution::
+    While running this on user accounts is possible, it is :strong:`not recommended` since it is against Discord's ToS.
+    I am not responsible if your account get's disabled for using self-bots, however there are some protections to make
+    it harder for the API to detect a self-bot.
+
+--------------------
+Basic example
+--------------------
+For basic example see `main_send_string.py <Examples/Message%20Types/TextMESSAGE/main_send_string.py>`_
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -31,12 +31,11 @@ Releases
 
 v2.1
 ===========
+- Changed the import ``import framework`` to ``import daf``. Using ``import framework`` is now deprecated.
 - ``remove_after`` parameter:
     Classes: :class:`daf.guild.GUILD`, :class:`daf.guild.USER`, :class:`daf.message.TextMESSAGE`, :class:`daf.message.VoiceMESSAGE`, :class:`daf.message.DirectMESSAGE`
 
     now support the remove_after parameter which will remove the object from the shilling list when conditions met.
-    
-
 - Proxies:
     Added support for using proxies.
     To use a proxy pass the :func:`daf.run` function with a ``proxy`` parameter
@@ -62,6 +61,9 @@ v2.1
 
             Time slippage correction
 
+    Slow mode correction:
+        Whenever a channel was in slow mode, it was not properly handled. This is now fixed.
+
 
 v2.0
 ===========
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -74,6 +74,8 @@
 
 # ----------- HTML ----------- #
 html_title = project
+html_logo = "images/logo.png"
+html_favicon = html_logo
 html_theme = 'furo'
 html_static_path = ['_static']
 html_theme_options = {
diff --git a/docs/source/images/logo.png b/docs/source/images/logo.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,7 +6,7 @@ The Discord advertisement framework is a  **shilling tool** that allows easy adv
 
 
 
-----------------------
+---------------------
 Links
 ----------------------
 .. tab-set::
@@ -46,18 +46,17 @@ Links
 Key features
 ----------------------
 - Ability to run on **user** accounts or **bot** accounts
+
+.. caution::
+    While running this on user accounts is possible, it is :strong:`not recommended` since it is against Discord's ToS.
+    I am not responsible if your account get's disabled for using self-bots!
+
 - Periodic advertisement to **Direct (Private) Messages**, **Text channels** and **Voice channels**
 - Advertising with either static data (text, embed, files, audio) or **dynamic data** (the data is obtained thru a function dynamically)
 - Logging of send attempts with **JSON** file logs or to a **SQL** server (Microsoft SQL Server only)
 - Ability to add additional application layers with help of asyncio
 - Easy to setup
 
-.. caution::
-    While running this on user accounts is possible, it is :strong:`not recommended` since it is against Discord's ToS.
-    I am not responsible if your account get's disabled for using self-bots, however there are some protections to make
-    it harder for the API to detect a self-bot.
-
-
 ----------------------
 Installation
 ----------------------
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 
 
 long_description = None
-with open("./README.md", "r", encoding="utf-8") as fh:
+with open("./README.rst", "r", encoding="utf-8") as fh:
     long_description = fh.read()
 
 req = None
diff --git a/src/daf/sql.py b/src/daf/sql.py
@@ -1017,13 +1017,11 @@ async def initialize(mgr_object: LoggerSQL) -> bool:
         try:
             await mgr_object.initialize()
             _ret = True
+            trace("[SQL]: Initialization was successful!", TraceLEVELS.NORMAL)
         except DAFSQLError as exc:
             trace(f"[SQL:] Unable to initialize manager, reason\n: {exc}", TraceLEVELS.ERROR)
-    else:
-        mgr_object = LoggerSQL("", "", "", "")
 
     GLOBALS.manager = mgr_object
-    trace("[SQL]: Initialization was successful!", TraceLEVELS.NORMAL)
     return _ret
 
 
diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-v2.1.rc1
+v2.1.rc1-1
