version.py

Go to the documentation of this file.

"""!
********************************************************************************
@file   version.py
@brief  Version and general information
********************************************************************************
"""
 
import sys
from typing import Optional
 
# Version
VERSION_MAJOR = 1  # major changes/breaks at API (e.g incompatibility)
VERSION_MINOR = 2  # minor changes/does not break the API (e.g new feature)
VERSION_PATCH = 0  # Bug fixes
VERSION_BUILD = 0  # build number (if available)
 
__title__ = "BonPrinter"
__description__ = "Thermal Printer tool"
__author__ = "Timo Unger"
__owner__ = "timounger"
__repo__ = "BonPrinterHome"
__copyright__ = f"Copyright © 2022-2025 {__author__}"
__license__ = "GNU General Public License"
__home__ = f"https://{__owner__}.github.io/{__repo__}"
 
if VERSION_BUILD == 0:
    PRERELEASE_BUILD = False
    __version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_PATCH}"
else:
    PRERELEASE_BUILD = True  # Mark the FW as a pre-release build and protect it from unauthorized use.
    __version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_PATCH}.{VERSION_BUILD}"
 
# debug/test code
 
 
def running_as_exe() -> bool:
    """!
    @brief Check if we are currently running as an executable or directly in Python
    @return [True|False] running as an EXE
    """
    # PyInstaller creates a temp folder and stores path in _MEIPASS
    return bool(hasattr(sys, "_MEIPASS"))
 
 
GIT_SHORT_SHA: Optional[str] = None
 
if running_as_exe():
    try:
        from Source.Util.git_version import GIT_SHORT_SHA  # type: ignore  # pylint: disable=unused-import
    except ImportError:
        GIT_SHORT_SHA = None