- Changed repository structure.

- Simplified code for GUI version. - Moved screenshots to `"./docs"` folder. Signed-off-by: schlopp96 <[email protected]>
schlopp96 · Apr 6, 2022 · 4210af0 · 4210af0
1 parent 915c96d
commit 4210af0
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 65 deletions.
diff --git a/src/DocuPort_PSG.pyw → DocuPort_PSG/DocuPort_PSG.pyw b/src/DocuPort_PSG.pyw → DocuPort_PSG/DocuPort_PSG.pyw
@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-#& DocuPort - PySimpleGUI v2.3.3b
+
 #! Simple GUI Script to open user-specified chapter of the Online-Documentation for PySimpleGUI.
 #@ =============================== Libraries =============================== @#
 from random import choice as rChoice
@@ -10,24 +10,23 @@ import PySimpleGUI as sg
 #@ ========================================================================= @#
 #$ =============================== Functions =============================== $#
 
+__version__ = '2.3.3b'
+
 #> Changes the base color layout each time the app is opened.
-theme: str = rChoice(sg.theme_list())
-sg.theme(theme)
+rtheme: str = rChoice(sg.theme_list())
+sg.theme(rtheme)
 
 
-def open_PSGUI(title: str, url: str) -> bool:
+def open_PSGUI(url: str) -> bool:
     """Open a specific PySimpleGUI documentation section in the user's default browser.
 
+    ---
     Parameters
-        :param title: title of the documentation-section selected.
-        :type title: str
         :param url: URL of the doc-section to open in user's default browser.
         :type url: str
         :return: opens new page/tab in browser.
         :rtype: None
     """
-    window_MAIN['-TEXT_TOP-'].update(f'Opening Doc Section: {title}')
-    window_MAIN.refresh()
     return open(url, new=2, autoraise=True)
 
 
@@ -71,13 +70,13 @@ menu_choices: dict = {
     'Multiple Windows':
     r'https://pysimplegui.readthedocs.io/en/latest/#running-multiple-windows',
     'Debug':
-    'https://pysimplegui.readthedocs.io/en/latest/#the-pysimplegui-debugger',
+    r'https://pysimplegui.readthedocs.io/en/latest/#the-pysimplegui-debugger',
     'User Settings API':
     r'https://pysimplegui.readthedocs.io/en/latest/#user-settings-api',
     'Extensions':
     r'https://pysimplegui.readthedocs.io/en/latest/#extending-pysimplegui',
     'Demo Apps':
-    'https://pysimplegui.readthedocs.io/en/latest/#demo-programs-applications',
+    r'https://pysimplegui.readthedocs.io/en/latest/#demo-programs-applications',
     'Create .EXE':
     r'https://pysimplegui.readthedocs.io/en/latest/#creating-a-windows-exe-file',
     'Create .MAC':
@@ -87,12 +86,12 @@ menu_choices: dict = {
 #& ========================================================================= &#
 #> ================================ Layouts ================================ <#
 winlayout = [
-    [  #* Top Row Text
+    [
         sg.Text('Choose Topic from PySimpleGUI Docs to Browse',
                 key='-TEXT_TOP-',
                 justification='Center')
     ],
-    [  #* Option Menu & Open URL Buttons
+    [
         sg.OptionMenu(key='-OPTION_MENU-',
                       values=list(menu_choices.keys()),
                       default_value=list(menu_choices.keys())[0],
@@ -103,60 +102,58 @@ winlayout = [
             tooltip=
             'Open selected section from online PySimpleGUI documentation using your default browser.'
         )
-    ],
-    #* Exit Button
-    [sg.Exit(tooltip='Exit the program.')],
-    #* Small Text to Display Current Theme
-    [sg.Text(f'Current Color Theme: {theme}', font='_ 8')],
-    #[
-    #    sg.Button('Random Theme',
-    #              k='-CHANGE_THEME-',
-    #              tooltip='Click for a random color scheme.',
-    #              font='_ 8')
-    #]
+    ], [sg.Exit(tooltip='Exit the program.')],
+    [sg.Text(f'Current Color Theme: {rtheme}', font='_ 8')]
 ]
 
 #@ Displays Window:
 window_MAIN = sg.Window(title='DocuPort - PySimpleGUI',
                         layout=winlayout,
                         element_justification='Center',
                         auto_size_buttons=True,
+                        auto_size_text=True,
                         keep_on_top=True,
                         element_padding=(1, 1),
                         margins=((3, 3)))
+
+
 #> ========================================================================= <#
 #$ ============================= Window Events ============================= $#
-while True:  #* Main event loop.
-    event, values = window_MAIN.read()
-    #print(event,values)  #NOTE: #? Enable to print stdout to console. #DEFAULT: -> OFF
-
-    #@ Closes Window upon clicking 'x' or sg.Exit() Button.
-    if event in [sg.WIN_CLOSED, 'Exit']:
-        break
-    if event == '-OPEN_URL-':
-        docs_section: str = values['-OPTION_MENU-']
-        if docs_section in menu_choices:
-            choice = menu_choices[docs_section]
-
-            #> If chosen option is a valid function:
-            if callable(choice):
-                choice() #< Call chosen function.
-
-            #* If chosen option is a string variable:
-            else:
-                open_PSGUI(title=docs_section, url=choice)
-                s(1.5)
-                window_MAIN['-TEXT_TOP-'].update('Done!')
-                window_MAIN.Refresh()
-                s(1)
-    #if event == '-CHANGE_THEME-':
-    #    sg.theme(new_theme=rChoice(sg.theme_list()))
-    #    window_MAIN['-TEXT_TOP-'].update(f'Theme changed to: {theme}!')
-    #    window_MAIN.Finalize()
-    #    s(0.5)
-    window_MAIN['-TEXT_TOP-'].update(
-        'Choose Topic from PySimpleGUI Docs to Browse')
-
-#! Close program and release computer resources:
-window_MAIN.close()
+def main():
+    while True:
+        event, values = window_MAIN.read()
+        print(event, values
+              )  #NOTE: #? Enable to print stdout to console. #DEFAULT: -> OFF
+
+        #@ Closes Window upon clicking 'x' or sg.Exit() Button.
+        if event in [sg.WIN_CLOSED, 'Exit']:
+            break
+        if event == '-OPEN_URL-':
+            docs_section: str = values['-OPTION_MENU-']
+            if docs_section in menu_choices:
+                choice = menu_choices[docs_section]
+
+                #> If chosen option is a valid function:
+                if callable(choice):
+                    choice()  #< Call chosen function.
+
+                #* If chosen option is a string variable:
+                else:
+                    open_PSGUI(url=choice)
+                    window_MAIN['-TEXT_TOP-'].update(
+                        f'Opening Doc Section: {docs_section}')
+                    window_MAIN.refresh()
+                    s(1.5)
+                    window_MAIN['-TEXT_TOP-'].update('Done!')
+                    window_MAIN.Refresh()
+                    s(1)
+        window_MAIN['-TEXT_TOP-'].update(
+            'Choose Topic from PySimpleGUI Docs to Browse')
+
+    window_MAIN.close()
+
+
+if __name__ == '__main__':
+    main()
+
 #$ ========================================================================= $#
diff --git a/src/DocuPort_PSG_CLI.py → DocuPort_PSG/DocuPort_PSG_CLI.py b/src/DocuPort_PSG_CLI.py → DocuPort_PSG/DocuPort_PSG_CLI.py
@@ -2,7 +2,7 @@
 #> Primitive CLI-Script to Open PySimpleGUI's Online-Documentation Within Your Default Browser. #
 
 from webbrowser import open as openURL
-from loadSequence import load
+from PyLoadBar import load
 from sys import exit as ex
 from time import sleep as s
 
@@ -230,8 +230,7 @@ def createMAC() -> None:
         inputCount += 1
         createMAC()
     elif menuchoice == '22':
-        load('Exiting', 'GoodBye!', False)
-        s(0.2)
+        load('Exiting', 'GoodBye!', enable_display=False)
         ex(0)
     else:
         inputCount = 0

diff --git a/DocuPort_PSG/__init__.py b/DocuPort_PSG/__init__.py
diff --git a/README.md b/README.md
@@ -1,9 +1,6 @@
 # DocuPort - PySimpleGUI
 
-> **_A.k.a. DocuPort PSG_**
->
 > - _A PySimpleGUI Online Documentation Portal_
-> - v2.3.3b
 
 ---
 
@@ -31,9 +28,9 @@ As a result, users must go online anytime the documentation is needed, which is
   - To exit or close the app, simply click the "X" at the top of the screen, or the "Exit" button at the bottom of the window.
   - **_That's it!_**
 
-    ![DocuPort PSG](DP_PSG_screenshot.png)
+    ![DocuPort PSG](./docs/DP_PSG_screenshot.png)
 
-    ![DocuPort PSG](DP_PSG_screenshot2.png)
+    ![DocuPort PSG](./docs/DP_PSG_screenshot2.png)
 
 ---
 
@@ -47,6 +44,6 @@ As a result, users must go online anytime the documentation is needed, which is
 - Simply follow the instructions displayed on screen, and you'll be fine!
 - The URL menu is **re-printed to the console every 5 user-inputs, or if user-input is anything that is not between [1-22]** _(e.g. if an incorrect input is entered)_.
 
-  ![DocuPort PSG CLI-Version](DP_PSG_CLI_screenshot.png)
+  ![DocuPort PSG CLI-Version](./docs/DP_PSG_CLI_screenshot.png)
 
 ---
diff --git a/DP_PSG_CLI_screenshot.png → docs/DP_PSG_CLI_screenshot.png b/DP_PSG_CLI_screenshot.png → docs/DP_PSG_CLI_screenshot.png
diff --git a/DP_PSG_screenshot.png → docs/DP_PSG_screenshot.png b/DP_PSG_screenshot.png → docs/DP_PSG_screenshot.png
diff --git a/DP_PSG_screenshot2.png → docs/DP_PSG_screenshot2.png b/DP_PSG_screenshot2.png → docs/DP_PSG_screenshot2.png