refactor: restructure source code

LizardByte · Aug 10, 2024 · f38d73a · f38d73a
1 parent 01d4d90
commit f38d73a
Show file tree

Hide file tree

Showing 51 changed files with 238 additions and 228 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -51,16 +51,16 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Install Python 3.9
+      - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.12'
           architecture: ${{ matrix.architecture }}
 
-      - name: Set up Python Dependencies
+      - name: Setup Python Dependencies
         run: |
-          python -m pip install --upgrade pip setuptools
-          python -m pip install -r requirements-dev.txt --no-warn-script-location
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install -r requirements-dev.txt
 
       - name: Compile Locale Translations
         run: |
@@ -108,7 +108,7 @@ jobs:
             --tb=native \
             --verbose \
             --color=yes \
-            --cov=pyra \
+            --cov=src \
             tests
 
       - name: Upload coverage

diff --git a/.github/workflows/localize.yml b/.github/workflows/localize.yml
@@ -6,9 +6,8 @@ on:
     branches: [master]
     paths:  # prevents workflow from running unless these files change
       - '.github/workflows/localize.yml'
-      - 'retroarcher.py'
       - 'locale/retroarcher.po'
-      - 'pyra/**.py'
+      - 'src/**.py'
       - 'web/templates/**'
   workflow_dispatch:
 
@@ -21,14 +20,14 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Install Python 3.9
+      - name: Install Python
         uses: actions/setup-python@v5  # https://github.com/actions/setup-python
         with:
-          python-version: '3.9'
+          python-version: '3.12'
 
-      - name: Set up Python 3.9 Dependencies
+      - name: Setup Python Dependencies
         run: |
-          python -m pip install --upgrade pip setuptools
+          python -m pip install --upgrade pip setuptools wheel
           python -m pip install -r requirements.txt
 
       - name: Update Strings

diff --git a/.gitignore b/.gitignore
@@ -155,8 +155,6 @@ cython_debug/
 node_modules/
 *package-lock.json
 
-# RetroArcher directories
+# project files and directories
 logs/
-
-# RetroArcher files
 *config.ini
diff --git a/Dockerfile b/Dockerfile
@@ -62,7 +62,7 @@ RUN groupadd -g 1000 retroarcher && \
 RUN mkdir -p /config
 VOLUME /config
 
-CMD ["python", "retroarcher.py"]
+CMD ["python", "./src/retroarcher.py"]
 
 EXPOSE 9696
 HEALTHCHECK --start-period=90s CMD python retroarcher.py --docker_healthcheck || exit 1
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,11 +19,13 @@
 script_dir = os.path.dirname(os.path.abspath(__file__))  # the directory of this file
 source_dir = os.path.dirname(script_dir)  # the source folder directory
 root_dir = os.path.dirname(source_dir)  # the root folder directory
+src_dir = os.path.join(root_dir, 'src')  # the src folder directory
 
 try:
-    sys.path.insert(0, root_dir)
-    from pyra import definitions  # put this in a try/except to prevent flake8 warning
-except Exception:
+    sys.path.insert(0, src_dir)
+    from common import definitions  # put this in a try/except to prevent flake8 warning
+except Exception as e:
+    print(f"Unable to import definitions from {root_dir}: {e}")
     sys.exit(1)
 
 # -- Project information -----------------------------------------------------

diff --git a/docs/source/contributing/localization.rst b/docs/source/contributing/localization.rst
@@ -43,7 +43,7 @@ situations. For example the system tray icon is user interfacing and therefore s
 - In order for strings to be extracted from python code, the following lines must be added.
    .. code-block:: python
 
-      from pyra import locales
+      from common import locales
       _ = locales.get_text()
 
 - Wrap the string to be extracted in a function as shown.
@@ -76,8 +76,7 @@ any of the following paths are modified.
 
 .. code-block:: yaml
 
-   - 'retroarcher.py'
-   - 'pyra/**.py'
+   - 'src/**.py'
    - 'web/templates/**'
 
 When testing locally it may be desirable to manually extract, initialize, update, and compile strings.

diff --git a/docs/source/pyra_docs/config.rst b/docs/source/pyra_docs/config.rst
diff --git a/docs/source/pyra_docs/hardware.rst b/docs/source/pyra_docs/hardware.rst
diff --git a/docs/source/pyra_docs/helpers.rst b/docs/source/pyra_docs/helpers.rst
diff --git a/docs/source/pyra_docs/locales.rst b/docs/source/pyra_docs/locales.rst
diff --git a/docs/source/pyra_docs/logger.rst b/docs/source/pyra_docs/logger.rst
diff --git a/docs/source/pyra_docs/threads.rst b/docs/source/pyra_docs/threads.rst
diff --git a/docs/source/pyra_docs/webapp.rst b/docs/source/pyra_docs/webapp.rst
diff --git a/docs/source/src/common/common.rst b/docs/source/src/common/common.rst
@@ -0,0 +1,7 @@
+.. include:: ../global.rst
+
+:modname:`common.__init__`
+--------------------------
+.. automodule:: common
+    :members:
+    :show-inheritance:
diff --git a/docs/source/pyra_docs/pyra.rst → docs/source/src/common/config.rst b/docs/source/pyra_docs/pyra.rst → docs/source/src/common/config.rst
@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
-:modname:`pyra.__init__`
+:modname:`common.config`
 ------------------------
-.. automodule:: pyra
+.. automodule:: common.config
     :members:
     :show-inheritance:
diff --git a/docs/source/src/common/definitions.rst b/docs/source/src/common/definitions.rst
@@ -0,0 +1,7 @@
+.. include:: ../global.rst
+
+:modname:`common.definitions`
+-----------------------------
+.. automodule:: common.definitions
+    :members:
+    :show-inheritance:
diff --git a/docs/source/src/common/hardware.rst b/docs/source/src/common/hardware.rst
@@ -0,0 +1,7 @@
+.. include:: ../global.rst
+
+:modname:`common.hardware`
+--------------------------
+.. automodule:: common.hardware
+    :members:
+    :show-inheritance:
diff --git a/docs/source/pyra_docs/tray_icon.rst → docs/source/src/common/helpers.rst b/docs/source/pyra_docs/tray_icon.rst → docs/source/src/common/helpers.rst
@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
-:modname:`pyra.tray_icon`
+:modname:`common.helpers`
 -------------------------
-.. automodule:: pyra.tray_icon
+.. automodule:: common.helpers
     :members:
     :show-inheritance:
diff --git a/docs/source/src/common/locales.rst b/docs/source/src/common/locales.rst
@@ -0,0 +1,7 @@
+.. include:: ../global.rst
+
+:modname:`common.locales`
+-------------------------
+.. automodule:: common.locales
+    :members:
+    :show-inheritance:
diff --git a/docs/source/src/common/logger.rst b/docs/source/src/common/logger.rst
@@ -0,0 +1,7 @@
+.. include:: ../global.rst
+
+:modname:`common.logger`
+------------------------
+.. automodule:: common.logger
+    :members:
+    :show-inheritance:
diff --git a/docs/source/src/common/threads.rst b/docs/source/src/common/threads.rst
@@ -0,0 +1,7 @@
+.. include:: ../global.rst
+
+:modname:`common.threads`
+-------------------------
+.. automodule:: common.threads
+    :members:
+    :show-inheritance:
diff --git a/docs/source/pyra_docs/definitions.rst → docs/source/src/common/tray_icon.rst b/docs/source/pyra_docs/definitions.rst → docs/source/src/common/tray_icon.rst
@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
-:modname:`pyra.definitions`
+:modname:`common.tray_icon`
 ---------------------------
-.. automodule:: pyra.definitions
+.. automodule:: common.tray_icon
     :members:
     :show-inheritance:
diff --git a/docs/source/src/common/webapp.rst b/docs/source/src/common/webapp.rst
@@ -0,0 +1,7 @@
+.. include:: ../global.rst
+
+:modname:`common.webapp`
+------------------------
+.. automodule:: common.webapp
+    :members:
+    :show-inheritance:
diff --git a/docs/source/global.rst → docs/source/src/global.rst b/docs/source/global.rst → docs/source/src/global.rst
diff --git a/docs/source/main/retroarcher.rst → docs/source/src/retroarcher.rst b/docs/source/main/retroarcher.rst → docs/source/src/retroarcher.rst
@@ -1,4 +1,4 @@
-.. include:: ../global.rst
+.. include:: global.rst
 
 :modname:`retroarcher`
 ----------------------

diff --git a/docs/source/toc.rst b/docs/source/toc.rst
@@ -22,14 +22,14 @@
    :caption: Code
    :titlesonly:
 
-   main/retroarcher
-   pyra_docs/pyra
-   pyra_docs/config
-   pyra_docs/definitions
-   pyra_docs/hardware
-   pyra_docs/helpers
-   pyra_docs/locales
-   pyra_docs/logger
-   pyra_docs/threads
-   pyra_docs/tray_icon
-   pyra_docs/webapp
+   src/retroarcher
+   src/common/common
+   src/common/config
+   src/common/definitions
+   src/common/hardware
+   src/common/helpers
+   src/common/locales
+   src/common/logger
+   src/common/threads
+   src/common/tray_icon
+   src/common/webapp
diff --git a/scripts/build.py b/scripts/build.py
@@ -14,7 +14,7 @@
 def build():
     """Sets arguments for pyinstaller, creates spec, and builds binaries."""
     pyinstaller_args = [
-        'retroarcher.py',
+        './src/retroarcher.py',
         '--onefile',
         '--noconfirm',
         '--paths=./',

diff --git a/src/__init__.py b/src/__init__.py
diff --git a/pyra/__init__.py → src/common/__init__.py b/pyra/__init__.py → src/common/__init__.py
@@ -15,10 +15,10 @@
 from typing import Union
 
 # local imports
-from pyra import config
-from pyra import definitions
-from pyra import helpers
-from pyra import logger
+from common import config
+from common import definitions
+from common import helpers
+from common import logger
 
 # get logger
 log = logger.get_logger(name=__name__)
@@ -121,7 +121,7 @@ def stop(exit_code: Union[int, str] = 0, restart: bool = False):
     >>> stop(exit_code=0, restart=False)
     """
     # stop the tray icon
-    from pyra.tray_icon import tray_end
+    from common.tray_icon import tray_end
     try:
         tray_end()
     except AttributeError:

diff --git a/pyra/config.py → src/common/config.py b/pyra/config.py → src/common/config.py
@@ -13,9 +13,9 @@
 from validate import Validator, ValidateError
 
 # local imports
-from pyra import definitions
-from pyra import logger
-from pyra import locales
+from common import definitions
+from common import logger
+from common import locales
 
 # get log
 log = logger.get_logger(name=__name__)
@@ -47,14 +47,14 @@ def on_change_tray_toggle() -> bool:
 
     See Also
     --------
-    pyra.tray_icon.tray_toggle : ``on_change_tray_toggle`` is an alias of this function.
+    common.tray_icon.tray_toggle : ``on_change_tray_toggle`` is an alias of this function.
 
     Examples
     --------
     >>> on_change_tray_toggle()
     True
     """
-    from pyra import tray_icon
+    from common import tray_icon
     return tray_icon.tray_toggle()
 
 

diff --git a/pyra/definitions.py → src/common/definitions.py b/pyra/definitions.py → src/common/definitions.py
@@ -124,8 +124,10 @@ class Paths:
 
     The purpose of this class is to ensure consistency when using these paths.
 
-    PYRA_DIR : str
-        The directory containing the retroarcher python files.
+    COMMON_DIR : str
+        The directory containing the common python files.
+    SRC_DIR : str
+        The directory containing the application python files
     ROOT_DIR : str
         The root directory of the application. This is where the source files exist.
     DATA_DIR : str
@@ -139,11 +141,12 @@ class Paths:
 
     Examples
     --------
-    >>> Paths.logs
+    >>> Paths.LOG_DIR
     '.../logs'
     """
-    PYRA_DIR = os.path.dirname(os.path.abspath(__file__))
-    ROOT_DIR = os.path.dirname(PYRA_DIR)
+    COMMON_DIR = os.path.dirname(os.path.abspath(__file__))
+    SRC_DIR = os.path.dirname(COMMON_DIR)
+    ROOT_DIR = os.path.dirname(SRC_DIR)
     DATA_DIR = ROOT_DIR
     BINARY_PATH = os.path.abspath(os.path.join(DATA_DIR, 'retroarcher.py'))