Merge pull request #28 from Athena-Chaos-Driven-Code/refactor

Major Refactor of entire library

Author: AnnaSasDev

.gitignore

@@ -1,5 +1,6 @@
 .idea/
 .run/
+/.old/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -1,86 +1,44 @@
-# - 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)
+# - AthenaTwitchLib -
+[![pypi](https://img.shields.io/pypi/v/AthenaTwitchLib)](https://pypi.org/project/AthenaTwitchLib/) [![GitHub license](https://img.shields.io/github/license/DirectiveAthena/AthenaTwitchLib)](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"
+- A library to create Twitch Chat Bots
+  - hard coded commands
+  - hard coded tasks
+  - Bots have the ability to pull commands from a database
+    - Currently supported databases: *Sqlite* (more will come in the future)
+  - Logging is handled by other Process
+    - Logs are stored to a Sqlite file
+
+- Features that are planned but still being worked on
+  - Twitch Helix API connector
+  - Task pulling from a database
+  - ...
 
 #### Python Version
-- Supported Python versions: **3.10**
-  - Other older versions of Python are not gonna be supported. 
+- Supported Python versions: **3.11**
+  - Other older versions of Python are not going to be supported.
 
 ---
-## 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).
+## Example
+**Currently, still in Alpha phase. Will have a good example working once version 1.0.0 is released**
 
-```python
-# --- Imports ---
-import os
-
-from AthenaTwitchBot.models.twitch_bot.twitch_bot import TwitchBot
-from AthenaTwitchBot.models.twitch_bot.bot_methods.bot_command import BotCommand
-from AthenaTwitchBot.models.twitch_bot.message_context import MessageContext
-from AthenaTwitchBot.models.launcher import Launcher
-from AthenaTwitchBot.models.twitch_channel import TwitchChannel
-
-# --- Code ---
-class SomeBot(TwitchBot):
-    def __init__(self):
-        super(SomeBot, self).__init__(
-            nickname=..., # <--- your bot name
-            oauth_token=os.getenv("TWITCH_TOKEN"),
-            channel=TwitchChannel(...), # <--- your channel name
-            command_prefix="!",
-            client_id=os.getenv("TWITCH_CLIENT_ID")
-        )
-
-    @BotCommand.register(name="today")
-    async def command_today(self, context: MessageContext):
-        context.reply(f"Today we will be working on: ..." )
-
-# -----------------------------------------------------------------------------
-def main():
-    Launcher.start_Bot(
-        bot=SomeBot(),
-        sll=True,
-    )
-
-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
+pip install AthenaTwitchLib --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
+- [GitHub Repo](https://github.com/DirectiveAthena/AthenaTwitchLib)     
+- [Pypi link](https://pypi.org/project/AthenaTwitchLib/)    
 
 ---
 Made By Andreas Sas,` 2022`

setup.py

@@ -18,28 +18,28 @@ def readme_handler() -> str:
 
 def version_handler() -> str:
     # ------------------------------------------------------------------------------------------------------------------
-    version = 0,8,1 # <-- DEFINE THE VERSION IN A TUPLE FORMAT HERE
+    version = 0,9,0 # <-- DEFINE THE VERSION IN A TUPLE FORMAT HERE
     # ------------------------------------------------------------------------------------------------------------------
     return ".".join(str(i) for i in version)
 
 setuptools.setup(
-    name="AthenaTwitchBot",
+    name="AthenaTwitchLib",
     version=version_handler(),
     author="Andreas Sas",
     author_email="",
-    description="A zero 3rd party dependency Twitch bot Connector",
+    description="A library to create Twitch Chat Bots and connect to the Twitch Helix API.",
     long_description=readme_handler(),
     long_description_content_type="text/markdown",
-    url="https://github.com/DirectiveAthena/AthenaTwitchBot",
+    url="https://github.com/Athena-Chaos-Driven-Code/AthenaTwitchLib",
     project_urls={
-        "Bug Tracker": "https://github.com/DirectiveAthena/AthenaTwitchBot/issues",
+        "Bug Tracker": "https://github.com/Athena-Chaos-Driven-Code/AthenaTwitchLib/issues",
     },
     license="GPLv3",
     package_dir={"": "src"},
     packages=setuptools.find_packages(where="src"),
-    python_requires=">=3.10",
+    python_requires=">=3.11",
     install_requires=[
-        "AthenaLib>=1.1.0",
-        "AthenaColor>=6.0.1"
+        "AthenaLib>=2.3.0",
+        "AthenaColor>=7.0.1"
     ]
 )