Merge pull request #11 from DirectiveAthena/v0.5.0_Proposal

V0.5.0 proposal

Author: AnnaSasDev

README.md

@@ -0,0 +1,95 @@
+# - AthenaTwitchBot -
+[![pypi](https://img.shields.io/pypi/v/AthenaTwitchBot)](https://pypi.org/project/AthenaTwitchBot/) [![GitHub license](https://img.shields.io/github/license/DirectiveAthena/AthenaTwitchBot)](https://github.com/DirectiveAthena/VerSC-AthenaColor/blob/master/LICENSE) [![Discord](https://img.shields.io/discord/814599159926620160?color=maroon)](https://discord.gg/6JcDbhXkCH) [![Downloads](https://pepy.tech/badge/athenatwitchbot)](https://pepy.tech/project/athenatwitchbot)
+
+--- 
+## Package Details
+#### Details and features 
+- A library to connect to the Twitch IRC system for a chatbot to utilize 
+- Isn't dependent on 3rd party packages, except for those that have been created by [@AndreasSas](https://github.com/AndreasSas)
+  - These can be designated by the leading "*Athena*..."
+  - These packages aren't seen as a 3rd party dependency as they are all made by the "same party"
+
+#### Python Version
+- Supported Python versions: **3.10**
+  - Other older versions of Python are not currently supported. 
+  - These older versions will probably not be supported by [@AndreasSas](https://github.com/AndreasSas) himself, but if you want to contribute to the project and make this package compatible with older versions of Python, Pull requests are always welcome.
+
+---
+## Quick Example
+The following example is a working bot, but currently only meant as proof of work as the package is still in its early stages of being developed and needs some heavy tuning.
+
+Stay tuned for updates while we work on this on [stream](https://www.twitch.tv/directiveathena) or come hang out in the [discord](https://discord.com/invite/6JcDbhXkCH).
+
+```python
+# --- Imports ---
+import AthenaTwitchBot  # Main import for the bot to work
+import AthenaColor      # Not needed for the following example, but is a dependency
+import AthenaLib        # Not needed for the following example, but is a dependency
+
+# --- Twitch bot ---
+class newBot(AthenaTwitchBot.TwitchBot):
+    def __init__(self):
+        super(newBot, self).__init__(
+            # Make sure you fill in the fields below
+            #   else the bot will not be able to be authenticated by Twitch
+            nickname="...",     # <--- The registered bot name
+            oauth_token="...",  # <--- the registered bots access token. Don't put this in plain text!
+            channel="...",      # <--- The twitch channel name you want to bind your bot to
+            prefix="!",         # <--- The "default" prefix is an exclamation point, but technically you can assign any string as a prefix 
+        )
+    
+    # - Command -
+    #   A command is only ran when it is invoked by a user in chat
+    #   In the following case this would be by typing "!ping" in chat
+    @AthenaTwitchBot.command_method(name="ping")
+    def command_ping(self, context: AthenaTwitchBot.TwitchMessageContext):
+        context.reply("pong!") # a "context.reply" function will reply to the user whi invoked the command
+        
+    # - Task -
+    #   A task is run automatically every "delay" amount of seconds
+    #   In the following case, the method will be run every minute
+    #   The "before" kwarg will 
+    @AthenaTwitchBot.scheduled_task_method(delay=60, before=True)
+    def task_post_github(self, context: AthenaTwitchBot.TwitchMessageContext):
+        context.write(f"This bot is made possible by: https://github.com/DirectiveAthena/AthenaTwitchBot")
+    
+# --- Main function ---
+def main():
+    AthenaTwitchBot.launch(
+        bot=newBot(),
+        ssl=True # set to true to enable ssl connection to Twitch
+    )
+
+if __name__ == '__main__':
+    main()
+
+```
+
+---
+## Documentation
+Full documentation can be found at:
+**[directiveathena.com/docu](https://publish.obsidian.md/directiveathena/)** (redirect to Obsidian.md publish site)
+(Reminder, the documentation is still under heavy development)
+
+---
+## Install
+To install the package in your Python environment
+
+```
+pip install AthenaTwitchBot --upgrade
+```
+
+---
+
+## Links 
+Project files can be found at:    
+- [GitHub Repo](https://github.com/DirectiveAthena/AthenaTwitchBot)     
+- [Pypi link](https://pypi.org/project/AthenaTwitchBot/)    
+
+---
+
+## Disclaimer
+With  *No Dependency*, the standard library is not counted as a dependency
+
+---
+Made By Andreas Sas,` 2022`

setup.py

@@ -12,12 +12,18 @@
 # ----------------------------------------------------------------------------------------------------------------------
 # - Code -
 # ----------------------------------------------------------------------------------------------------------------------
+def readme_handler() -> str:
+    with open("README.md", "r") as readme_file:
+        return readme_file.read()
+
 def version_handler() -> str:
-    version = 0,4,0
+    # ------------------------------------------------------------------------------------------------------------------
+    version = 0,5,0 # <-- DEFINE THE VERSION IN A TUPLE FORMAT HERE
+    # ------------------------------------------------------------------------------------------------------------------
     version_str = ".".join(str(i) for i in version)
 
     with open("src/AthenaTwitchBot/_info/_v.py", "w") as file:
-        file.write(f"def _version():\n    return '{version_str}'")
+        file.write(f"VERSION='{version_str}'")
 
     return version_str
 
@@ -26,7 +32,9 @@ def version_handler() -> str:
     version=version_handler(),
     author="Andreas Sas",
     author_email="",
-    description="A Twitch bot Connector",
+    description="A zero 3rd party dependency Twitch bot Connector",
+    long_description=readme_handler(),
+    long_description_content_type="text/markdown",
     url="https://github.com/DirectiveAthena/AthenaTwitchBot",
     project_urls={
         "Bug Tracker": "https://github.com/DirectiveAthena/AthenaTwitchBot/issues",

src/AthenaTwitchBot/__init__.py

@@ -6,6 +6,9 @@
 
 from AthenaTwitchBot.models.twitch_bot import TwitchBot
 from AthenaTwitchBot.models.twitch_bot_protocol import TwitchBotProtocol
+from AthenaTwitchBot.models.twitch_message_context import TwitchMessageContext
 
-# keep this function to be the last to be imported
 from AthenaTwitchBot.functions.launch import launch
+
+# noinspection PyProtectedMember
+from AthenaTwitchBot._info.info import info # a general info printer

src/AthenaTwitchBot/_info/_v.py

@@ -1,2 +1 @@
-def _version():
-    return '0.4.0'
+VERSION='0.5.0'

src/AthenaTwitchBot/_info/info.py

@@ -0,0 +1,40 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# - Package Imports -
+# ----------------------------------------------------------------------------------------------------------------------
+# General Packages
+from __future__ import annotations
+
+# Custom Library
+
+# Custom Packages
+# noinspection PyProtectedMember
+import AthenaLib._info.formatting as f
+from AthenaTwitchBot._info._v import VERSION
+
+# ----------------------------------------------------------------------------------------------------------------------
+# - Code -
+# ----------------------------------------------------------------------------------------------------------------------
+def info(*, to_str: bool = False) -> None | str:
+    # todo needs a lot of work
+    line = "-" * 128
+    header = f.header(f"""{line}
+{f.title("AthenaTwitchBot", to_str)} v{VERSION}
+is made by Andreas Sas.
+{line}
+""", to_str)
+
+    body = f"""
+Package setup:
+    {f.sub_modules("data", to_str)} : ...
+    {f.sub_modules("decorators", to_str)} : ...
+    {f.sub_modules("functions", to_str)} : ...
+    {f.sub_modules("models", to_str)} : ...
+"""
+
+    text = f"{header}{body}{line}"
+
+    # export to console or string
+    if to_str:
+        return text
+    else:
+        print(text)