modularize src

+ merge main.py and manage.py
+ move start logic to swingmusic/__main__.py
+ add a run.py on the project root

swingmusic/settings.py

@@ -0,0 +1,330 @@
+"""
+Contains default configs
+"""
+
+import os
+import subprocess
+import sys
+
+from swingmusic import configs
+from swingmusic.utils.filesystem import get_home_res_path
+
+join = os.path.join
+
+if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
+    IS_BUILD = True
+else:
+    IS_BUILD = False
+
+
+class Paths:
+    USER_HOME_DIR = os.path.expanduser("~")
+
+    # TODO: Break this down into getter methods for each path
+
+    @classmethod
+    def set_config_dir(cls, path: str):
+        cls.XDG_CONFIG_DIR = path
+
+    @classmethod
+    def get_config_dir(cls):
+        return (
+            # cls.XDG_CONFIG_DIR
+            os.environ.get("SWINGMUSIC_XDG_CONFIG_DIR") or os.path.realpath(".")
+        )
+
+    @classmethod
+    def get_config_folder(cls):
+        return (
+            "swingmusic" if cls.get_config_dir() != cls.USER_HOME_DIR else ".swingmusic"
+        )
+
+    @classmethod
+    def get_app_dir(cls):
+        return join(cls.get_config_dir(), cls.get_config_folder())
+
+    @classmethod
+    def get_img_path(cls):
+        return join(cls.get_app_dir(), "images")
+
+    # ARTISTS
+    @classmethod
+    def get_artist_img_path(cls):
+        return join(cls.get_img_path(), "artists")
+
+    @classmethod
+    def get_sm_artist_img_path(cls):
+        return join(cls.get_artist_img_path(), "small")
+
+    @classmethod
+    def get_md_artist_img_path(cls):
+        return join(cls.get_artist_img_path(), "medium")
+
+    @classmethod
+    def get_lg_artist_img_path(cls):
+        return join(cls.get_artist_img_path(), "large")
+
+    # TRACK THUMBNAILS
+    @classmethod
+    def get_thumbs_path(cls):
+        return join(cls.get_img_path(), "thumbnails")
+
+    @classmethod
+    def get_sm_thumb_path(cls):
+        return join(cls.get_thumbs_path(), "small")
+
+    @classmethod
+    def get_xsm_thumb_path(cls):
+        return join(cls.get_thumbs_path(), "xsmall")
+
+    @classmethod
+    def get_md_thumb_path(cls):
+        return join(cls.get_thumbs_path(), "medium")
+
+    @classmethod
+    def get_lg_thumb_path(cls):
+        return join(cls.get_thumbs_path(), "large")
+
+    # OTHERS
+    @classmethod
+    def get_playlist_img_path(cls):
+        return join(cls.get_img_path(), "playlists")
+
+    @classmethod
+    def get_assets_path(cls):
+        return join(Paths.get_app_dir(), "assets")
+
+    @classmethod
+    def get_plugins_path(cls):
+        return join(Paths.get_app_dir(), "plugins")
+
+    @classmethod
+    def get_lyrics_plugins_path(cls):
+        return join(Paths.get_plugins_path(), "lyrics")
+
+    @classmethod
+    def get_config_file_path(cls):
+        return join(cls.get_app_dir(), "settings.json")
+
+    @classmethod
+    def get_mixes_img_path(cls):
+        return join(cls.get_img_path(), "mixes")
+
+    @classmethod
+    def get_artist_mixes_img_path(cls):
+        return join(cls.get_mixes_img_path(), "artists")
+
+    @classmethod
+    def get_og_mixes_img_path(cls):
+        return join(cls.get_mixes_img_path(), "original")
+
+    @classmethod
+    def get_md_mixes_img_path(cls):
+        return join(cls.get_mixes_img_path(), "medium")
+
+    @classmethod
+    def get_sm_mixes_img_path(cls):
+        return join(cls.get_mixes_img_path(), "small")
+
+    @classmethod
+    def get_image_cache_path(cls):
+        return join(cls.get_img_path(), "cache")
+
+
+# defaults
+class Defaults:
+    """
+    Contains default values for various settings.
+
+    XSM_THUMB_SIZE: extra small thumbnail size for web client tracklist
+    SM_THUMB_SIZE: small thumbnail size for android client tracklist
+    MD_THUMB_SIZE: medium thumbnail size for web client album cards
+    LG_THUMB_SIZE: large thumbnail size for web client now playing album art
+
+    NOTE: LG_ARTIST_IMG_SIZE is not defined as the images are saved in the original size (500px)
+    """
+
+    XSM_THUMB_SIZE = 64
+    SM_THUMB_SIZE = 96
+    MD_THUMB_SIZE = 256
+    LG_THUMB_SIZE = 512
+
+    SM_ARTIST_IMG_SIZE = 128
+    MD_ARTIST_IMG_SIZE = 256
+
+    HASH_LENGTH = 16
+    API_ALBUMHASH = "bfe300e966"
+    API_ARTISTHASH = "cae59f1fc5"
+    API_TRACKHASH = "0853280a12"
+    API_ALBUMNAME = "The Goat"
+    API_ARTISTNAME = "Polo G"
+    API_TRACKNAME = "Martin & Gina"
+    API_CARD_LIMIT = 6
+
+
+# ===== SQLite =====
+class DbPaths:
+    APP_DB_NAME = "swingmusic.db"
+    USER_DATA_DB_NAME = "userdata.db"
+
+    @classmethod
+    def get_app_db_path(cls):
+        return join(Paths.get_app_dir(), cls.APP_DB_NAME)
+
+    @classmethod
+    def get_userdata_db_path(cls):
+        return join(Paths.get_app_dir(), cls.USER_DATA_DB_NAME)
+
+    @classmethod
+    def get_json_config_path(cls):
+        return join(Paths.get_app_dir(), "config.json")
+
+
+class FLASKVARS:
+    FLASK_PORT = 1970
+    FLASK_HOST = "localhost"
+
+    @classmethod
+    def get_flask_port(cls):
+        return cls.FLASK_PORT
+
+    @classmethod
+    def get_flask_host(cls):
+        return cls.FLASK_HOST
+
+    @classmethod
+    def set_flask_port(cls, port):
+        cls.FLASK_PORT = port
+
+    @classmethod
+    def set_flask_host(cls, host):
+        cls.FLASK_HOST = host
+
+
+class ALLARGS:
+    """
+    Enumerates the possible app arguments.
+    """
+
+    build = "--build"
+    port = "--port"
+    host = "--host"
+    config = "--config"
+
+    pswd = "--pswd"
+
+    show_feat = ("--show-feat", "-sf")
+    show_prod = ("--show-prod", "-sp")
+    dont_clean_albums = ("--no-clean-albums", "-nca")
+    dont_clean_tracks = ("--no-clean-tracks", "-nct")
+    no_periodic_scan = ("--no-periodic-scan", "-nps")
+    periodic_scan_interval = ("--scan-interval", "-psi")
+
+    help = ("--help", "-h")
+    version = ("--version", "-v")
+
+
+class SessionVars:
+    """
+    Variables that can be altered per session.
+    """
+
+    EXTRACT_FEAT = True
+    """
+    Whether to extract the featured artists from the song title.
+    """
+
+    REMOVE_PROD = True
+    """
+    Whether to remove the producers from the song title.
+    """
+
+    CLEAN_ALBUM_TITLE = True
+    REMOVE_REMASTER_FROM_TRACK = True
+
+    DO_PERIODIC_SCANS = True
+    PERIODIC_SCAN_INTERVAL = 600  # 10 minutes
+    """
+    The interval between periodic scans in seconds.
+    """
+
+    MERGE_ALBUM_VERSIONS = False
+    ARTIST_SEPARATORS = set()
+    SHOW_ALBUMS_AS_SINGLES = False
+
+
+class TCOLOR:
+    """
+    Terminal colors
+    """
+
+    HEADER = "\033[95m"
+    OKBLUE = "\033[94m"
+    OKCYAN = "\033[96m"
+    OKGREEN = "\033[92m"
+    YELLOW = "\033[93m"
+    FAIL = "\033[91m"
+    ENDC = "\033[0m"
+    BOLD = "\033[1m"
+    UNDERLINE = "\033[4m"
+    # credits: https://stackoverflow.com/a/287944
+
+
+def getLatestCommitHash():
+    """
+    Returns the latest git commit hash for the current branch
+    """
+
+    try:
+        hash = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"])
+        return hash.decode("utf-8").strip()
+    except:
+        return ""
+
+
+def getCurrentBranch():
+    """
+    Returns the current git branch
+    """
+
+    try:
+        branch = subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])
+        return branch.decode("utf-8").strip()
+    except:
+        return ""
+
+
+class Info:
+    """
+    Contains information about the app
+
+    NOTE: This class initially written to load keys when running in build mode.
+    TODO: Remove this class entirely, and implement functionality where needed.
+    """
+
+    SWINGMUSIC_APP_VERSION = os.environ.get("SWINGMUSIC_APP_VERSION")
+
+    if not SWINGMUSIC_APP_VERSION:
+        path = get_home_res_path("version.txt")
+        if not path:
+            raise ValueError("Version file not found")
+
+        with open(path, "r") as f:
+            SWINGMUSIC_APP_VERSION = f.read().strip()
+
+    GIT_LATEST_COMMIT_HASH = "<unset>"
+    GIT_CURRENT_BRANCH = "<unset>"
+
+    @classmethod
+    def load(cls):
+        if IS_BUILD:
+            cls.SWINGMUSIC_APP_VERSION = configs.SWINGMUSIC_APP_VERSION
+            cls.GIT_LATEST_COMMIT_HASH = configs.GIT_LATEST_COMMIT_HASH
+            cls.GIT_CURRENT_BRANCH = configs.GIT_CURRENT_BRANCH
+        else:
+            cls.GIT_LATEST_COMMIT_HASH = getLatestCommitHash()
+            cls.GIT_CURRENT_BRANCH = getCurrentBranch()
+
+    @classmethod
+    def get(cls, key: str):
+        return getattr(cls, key, None)