remove_after, refactoring, documentation (#168)

* remove_after on guild, refactoring, documentation

* remove_after on xMESSAGE & optimizations

* Documentation

* _update_state method, refactoring of auto-removal

* Bug Fixes

* Remove useless code

* Fixed DirectMESSAGE counter

Author: davidhozic

Examples/Dynamic Modification/main.py

@@ -46,7 +46,7 @@ async def user_task():
     await asyncio.sleep(10)
     fw.trace("Updating the TextMESSAGE object")
     # Update the object
-    await text_msg.update(data="Updated Data", end_period=60) 
+    await text_msg.update(data="Updated Data", end_period=timedelta(seconds=60)) 
 
     fw.trace("Now shilling 'Updated Data' with period of 60 seconds")
     #########################################################################

Examples/Message Types/DirectMESSAGE/main_send_string.py

@@ -23,7 +23,7 @@
                                                             # the previous message and then send a new one
                               start_in=timedelta(seconds=0)                # Start sending now (True) or wait until period
                               ),
-            framework.TextMESSAGE(start_period=5, end_period=10, data="Second Message", channels=[12345], mode="send", start_in=timedelta(seconds=0))  
+            framework.TextMESSAGE(start_period=5, end_period=timedelta(10), data="Second Message", channels=[12345], mode="send", start_in=timedelta(seconds=0))  
         ],
         logging=True                                   ## Generate file log of sent messages (and failed attempts) for this user
     )

Examples/Message Types/TextMESSAGE/main_send_string.py

@@ -24,7 +24,7 @@
                                                             # the previous message and then send a new one
                               start_in=timedelta(seconds=0)                # Start sending now (True) or wait until period
                               ),
-            framework.TextMESSAGE(start_period=5, end_period=10, data="Second Message", channels=[12345], mode="send", start_in=timedelta(seconds=0))  
+            framework.TextMESSAGE(start_period=5, end_period=timedelta(10), data="Second Message", channels=[12345], mode="send", start_in=timedelta(seconds=0))  
         ],
         logging=True           ## Generate file log of sent messages (and failed attempts) for this server 
     )

docs/source/changelog.rst

@@ -1,30 +1,71 @@
+========================
 Changelog
 ========================
+.. |BREAK_CH| replace:: **[Breaking change]**
+
+.. |POTENT_BREAK_CH| replace:: **[Potentially breaking change]**
+
+------------------------
+Info
+------------------------
+
 .. seealso:: 
-    `Releases <https://github.com/davidhozic/discord-advertisement-framework/releases>`_
+    `Releases <https://github.com/davidhozic/discord-advertisement-framework/releases>`_  
 
 .. note:: 
     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.
 
-v2.1
+
+Glossary
+======================
+.. glossary::
+
+    |BREAK_CH|
+        Means that the change will break functionality from previous version.
+
+
 ----------------------
-- Proxy support
-- Removed discord.EmbedField class, it is now replaced with discord.EmbedField
-- ``timedelta`` object on ``start_period/end_period`` parameters
-- Replaced ``start_now`` with ``start_in`` parameter, deprecated use of bool value
-- :class:`framework.TextMESSAGE` and :class:`framework.VoiceMESSAGE` now check if the given channels are actually inside the guild
-- Optional dependencies `voice` and `proxy` - to install use ``pip install discord-advert-framework[voice]`` and ``pip install discord-advert-framework[proxy]``
-- Time slippage correction:
+Releases
+----------------------
+
+v2.1
+===========
+:``remove_after`` parameter:
+    Classes: :class:`framework.guild.GUILD`, :class:`framework.guild.USER`, :class:`framework.message.TextMESSAGE`, :class:`framework.message.VoiceMESSAGE`, :class:`framework.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:`framework.run` function with a ``proxy`` parameter
+:discord.EmbedField:
+    |BREAK_CH| Replaced framework.EmbedFIELD with discord.EmbedField.
+:timedelta:
+    start_period and end_period now support ``timedelta`` object to specify the send period.
+    Use of ``int`` is deprecated
+
+    |POTENT_BREAK_CH| Replaced ``start_now`` with ``start_in`` parameter, deprecated use of bool value.
+
+:Channel checking:
+    :class:`framework.TextMESSAGE` and :class:`framework.VoiceMESSAGE` now check if the given channels are actually inside the guild
+
+:Optionals:
+    |POTENT_BREAK_CH| Made some functionality optional: ``voice``, ``proxy`` and ``sql`` - to install use ``pip install discord-advert-framework[dependency here]``
 
-.. figure:: images/changelog_2_1_slippage_fix.png    
+:Bug fixes:
+    Time slippage correction:
+        This occurred if too many messages were ready at once, which resulted in discord's rate limit,
+        causing a permanent slip.
 
-    Time slippage correction
+        .. figure:: images/changelog_2_1_slippage_fix.png    
+
+            Time slippage correction
 
-  
 
 v2.0
-----------------------
+===========
 - New cool looking web documentation (the one you're reading now)
 - Added volume parameter to :class:`framework.VoiceMESSAGE`
 - Changed ``channel_ids`` to ``channels`` for :class:`framework.VoiceMESSAGE` and :class:`framework.TextMESSAGE`. It can now also accept discord.<Type>Channel objects.
@@ -35,20 +76,20 @@ v2.0
 - Bug fixes and other small improvements.
 
 v1.9.0
-----------------------
+===========
 - Added support for logging into a SQL database (MS SQL Server only). See :ref:`relational database log (SQL)`.
 - :func:`framework.run` function now accepts discord.Intents.
 - :func:`framework.add_object` and :func:`framework.remove_object` functions created to allow for dynamic modification of the shilling list.
 - Other small improvements.
 
 v1.8.1
-----------------------
+===========
 - JSON file logging.
 - Automatic channel removal if channel get's deleted and message removal if all channels are removed.
 - Improved debug messages.
 
 v1.7.9
-----------------------
+===========
 - :class:`framework.DirectMESSAGE` and :class:`framework.USER` classes created for direct messaging.
 
 

docs/source/classes.rst

@@ -16,6 +16,8 @@ GUILD
 
    .. autoproperty:: snowflake
 
+   .. autoproperty:: created_at
+
 USER
 =====================
 .. autoclass:: framework.guild.USER
@@ -25,6 +27,7 @@ USER
 
    .. autoproperty:: snowflake
 
+   .. autoproperty:: created_at
 
 -----------------------------
 Messages
@@ -35,22 +38,22 @@ TextMESSAGE
 .. autoclass:: framework.message.TextMESSAGE
     :members:
 
-    .. autoproperty:: deleted
+    .. autoproperty:: created_at
 
 VoiceMESSAGE
 =====================
 .. autoclass:: framework.message.VoiceMESSAGE
     :members:
 
-    .. autoproperty:: deleted
+    .. autoproperty:: created_at
+
 
 DirectMESSAGE
 =====================
 .. autoclass:: framework.message.DirectMESSAGE
     :members:
 
-    .. autoproperty:: deleted
-
+    .. autoproperty:: created_at
 
 
 -----------------------------
@@ -152,77 +155,57 @@ Error codes
 
 .. glossary::
 
-    DAF_GUILD_ALREADY_ADDED:
-        Value: 0
-
-        Info: Guild with specified snowflake is already added.
-
-    DAF_GUILD_ID_REQUIRED:
+    DAF_SNOWFLAKE_NOT_FOUND:
         Value: 1
 
-        Info: Guild ID is required but was not passed.
-
-    DAF_GUILD_ID_NOT_FOUND:
-        Value: 2
-
         Info: Guild with specified snowflake was not found (or user).
 
     DAF_USER_CREATE_DM:
-        Value: 3
+        Value: 2
 
         Info: Was unable to create DM with user (probably user not found).
 
     DAF_YOUTUBE_STREAM_ERROR:
-        Value: 5
+        Value: 3
 
         Info: The given youtube link could not be streamed (AUDIO, VoiceMESSAGE).
 
     DAF_FILE_NOT_FOUND:
-        Value: 6
+        Value: 4
 
         Info: The given file was not found.
 
-    DAF_MISSING_PARAMETER:
-        Value: 7
-
-        Info: The parameter(s) is(are) missing.
-
-    DAF_CHANNEL_GUILD_MISMATCH_ERROR:
-        Value: 8
-
-        Info: The channel with given ID does not belong into this guild but is part of a different guild.
-
     DAF_SQL_CREATE_TABLES_ERROR:
-        Value: 9
+        Value: 5
 
         Info: Unable to create all the tables.
 
     DAF_SQL_LOOKUPTABLE_NOT_FOUND:
-        Value: 10
+        Value: 6
 
         Info: The lookup table was not found.
 
     DAF_SQL_BEGIN_ENGINE_ERROR:
-        Value: 11
+        Value: 7
 
         Info: Unable to start engine.
 
     DAF_SQL_CR_LT_VALUES_ERROR:
-        Value: 12
+        Value: 8
 
         Info: Unable to create lookuptables' rows.
 
     DAF_SQL_CREATE_DT_ERROR:
-        Value: 13
+        Value: 9
 
         Info: Unable to create SQL data types.
 
     DAF_SQL_CREATE_VPF_ERROR:
-        Value: 14
+        Value: 10
 
         Info: Unable to create views, procedures and functions.
 
     DAF_SQL_CURSOR_CONN_ERROR:
-        Value: 15
+        Value: 11
 
         Info: Unable to connect the cursor.

docs/source/conf.py

@@ -60,7 +60,7 @@
 
 
 # Autodoc
-autodoc_typehints = "both"
+autodoc_typehints = "signature"
 autodoc_typehints_format = "short"