Feature: Addition of __main__.py file

Author: DirectiveAthena

Docu/Version History.md

@@ -0,0 +1,5 @@
+# v3.0.3
+- Updated links to exsist under the new DirectiveAthena Organization on GitHub
+- new `__main__.py` file to execute the readme function when the Package is executed through the terminal with the following command : `python -m AthenaColor`
+
+---

Docu/VersionHistory/v3.0.3.md

@@ -1,49 +1,51 @@
-# *-* Base Needed imports *-*
-from AthenaColor import (
-    Fore,   # All predefined Foreground colors
-    Back,   # All predefined Background colors
-    Style,  # All Style makeups
-    rgb,
-)
-
-# *-* Use the objects in an f-string *-*  
-print(
+def readme():
+    # *-* Base Needed imports *-*
+    from AthenaColor import (
+        Fore,   # All predefined Foreground colors
+        Back,   # All predefined Background colors
+        Style,  # All Style makeups
+        rgb,
+    )
+
+    # *-* Use the objects in an f-string *-*
+    print(
 f"""||| {Style.Bold}Welcome to the AthenaColor Package!{Style.Reset} |||  
 
 - The {Fore.HotPink}Fore.HotPink{Style.Reset} Changes the Foreground color  
 - The {Back.Indigo}Back.Indigo{Style.Reset} changes the background color  
 - Combinations like {Back.Teal}{Fore.LightGoldenRodYellow}Back.Teal + Fore.LightGoldenRodYellow{Style.Reset} are also supported  
 - Using {Fore.custom(rgb(123,45,67))}Fore.custom(rgb(123,45,67)){Style.Reset} will allow you to use custom rgb colors
 """
-)
+    )
 
-# *-* Create your own rgb objects *-*  
-custom_color = rgb(r=86, g=54, b=186)
-print(
+    # *-* Create your own rgb objects *-*
+    custom_color = rgb(r=86, g=54, b=186)
+    print(
 f"""
 {Fore.custom(custom_color)}Text with a newly made rgb object{Style.Reset}
 {Fore.rgb(r=186, g=54, b=86)}Text without first making a custom rgb object{Style.Reset}
 """
-)
+    )
 
-# *-* Print out of all colours and Style Formats *-*  
-from AthenaColor.Help import (
-    AllTable,
-    AllBoxes
-)
+    # *-* Print out of all colours and Style Formats *-*
+    from AthenaColor.Help import (
+        AllTable,
+        AllBoxes
+    )
 
-print(
+    print(
 f"""
 {Style.Bold}The following is a full list of all predefined colors.  
 Together with all Style makeups found in AthenaColor.ConsolePrinter:{Style.Reset}
 """
-)
+    )
 
-AllTable()
+    AllTable()
 
-print(
+    print(
 f"""
 {Style.Bold}The following is a small view of all predefined colors:{Style.Reset}
-""")
+"""
+    )
 
-AllBoxes()
+    AllBoxes()

src/AthenaColor/Help/readme.py

@@ -0,0 +1,15 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# - Package Imports -
+# ----------------------------------------------------------------------------------------------------------------------
+# General Packages
+
+# Custom Library
+
+# Custom Packages
+from AthenaColor.Help.readme import readme
+
+# ----------------------------------------------------------------------------------------------------------------------
+# - Code -
+# ----------------------------------------------------------------------------------------------------------------------
+if __name__ == "__main__":
+    readme()