novelWriter 2.6.3__py3-none-any.whl → 2.7__py3-none-any.whl

novelwriter/__init__.py

@@ -25,31 +25,33 @@ from __future__ import annotations
 
 import getopt
 import logging
+import os
 import sys
 
 from typing import TYPE_CHECKING
 
-from PyQt5.QtWidgets import QApplication, QErrorMessage
+from PyQt6.QtWidgets import QApplication, QErrorMessage
 
 from novelwriter.config import Config
 from novelwriter.error import exceptionHandler
 from novelwriter.shared import SharedData
+from novelwriter.splash import NSplashScreen
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from novelwriter.guimain import GuiMain
 
 # Package Meta
 # ============
 
 __package__    = "novelwriter"
-__copyright__  = "Copyright 2018–2024, Veronica Berglyd Olsen"
+__copyright__  = "Copyright 2018-2025 Veronica Berglyd Olsen"
 __license__    = "GPLv3"
 __author__     = "Veronica Berglyd Olsen"
 __maintainer__ = "Veronica Berglyd Olsen"
 __email__      = "code@vkbo.net"
-__version__    = "2.6.3"
-__hexversion__ = "0x020603f0"
-__date__       = "2025-02-16"
+__version__    = "2.7"
+__hexversion__ = "0x020700f0"
+__date__       = "2025-06-01"
 __status__     = "Stable"
 __domain__     = "novelwriter.io"
 
@@ -65,20 +67,24 @@ CONFIG = Config()
 SHARED = SharedData()
 
 # ANSI Colours
-C_RED    = "\033[91m"
-C_GREEN  = "\033[92m"
-C_YELLOW = "\033[93m"
-C_BLUE   = "\033[94m"
-C_WHITE  = "\033[97m"
-C_END    = "\033[0m"
-
-# Log Formats
-L_TIME = "[{asctime:}]"
-L_FILE = "{filename:>18}"
-L_LINE = "{lineno:<4d}"
-L_LVLP = "{levelname:8}"
-L_LVLC = "{levelname:17}"
-L_TEXT = "{message:}"
+RED    = "\033[91m"
+GREEN  = "\033[92m"
+YELLOW = "\033[93m"
+BLUE   = "\033[94m"
+WHITE  = "\033[97m"
+END    = "\033[0m"
+
+# Log Format Components
+TIME = "[{asctime:}]"
+FILE = "{filename:>18}"
+LINE = "{lineno:<4d}"
+LVLP = "{levelname:8}"
+LVLC = "{levelname:17}"
+TEXT = "{message:}"
+
+# Read Environment
+FORCE_COLOR = bool(os.environ.get("FORCE_COLOR"))
+NO_COLOR    = bool(os.environ.get("NO_COLOR"))
 
 
 def main(sysArgs: list | None = None) -> GuiMain | None:
@@ -87,7 +93,7 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
         sysArgs = sys.argv[1:]
 
     # Valid Input Options
-    shortOpt = "hv"
+    shortOpt = "hvidc"
     longOpt = [
         "help",
         "version",
@@ -97,7 +103,6 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
         "style=",
         "config=",
         "data=",
-        "testmode",
         "meminfo"
     ]
 
@@ -105,29 +110,37 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
         f"novelWriter {__version__} ({__date__})\n"
         f"{__copyright__}\n"
         "\n"
+        "This program is free software: you can redistribute it and/or modify\n"
+        "it under the terms of the GNU General Public License as published by\n"
+        "the Free Software Foundation, either version 3 of the License, or\n"
+        "(at your option) any later version.\n"
+        "\n"
         "This program is distributed in the hope that it will be useful,\n"
         "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
         "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
         "GNU General Public Licence for more details.\n"
         "\n"
+        "You should have received a copy of the GNU General Public License\n"
+        "along with this program. If not, see <https://www.gnu.org/licenses/>.\n"
+        "\n"
         "Usage:\n"
         " -h, --help     Print this message.\n"
         " -v, --version  Print program version and exit.\n"
-        "     --info     Print additional runtime information.\n"
-        "     --debug    Print debug output. Includes --info.\n"
-        "     --color    Add ANSI colors to log output.\n"
+        " -i, --info     Print additional runtime information.\n"
+        " -d, --debug    Print debug output. Includes --info.\n"
+        " -c, --color    Add ANSI colors to log output.\n"
         "     --meminfo  Show memory usage information in the status bar.\n"
-        "     --style=   Sets Qt5 style flag. Defaults to 'Fusion'.\n"
+        "     --style=   Sets Qt style flag. Defaults to 'Fusion'.\n"
         "     --config=  Alternative config file.\n"
         "     --data=    Alternative user data path.\n"
     )
 
     # Defaults
     logLevel = logging.WARN
-    fmtFlags = 0b00
+    fmtColor = FORCE_COLOR
+    fmtLong  = False
     confPath = None
     dataPath = None
-    testMode = False
     qtStyle  = "Fusion"
     cmdOpen  = None
 
@@ -136,7 +149,7 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
         inOpts, inRemain = getopt.getopt(sysArgs, shortOpt, longOpt)
     except getopt.GetoptError as exc:
         print(helpMsg)
-        print(f"ERROR: {str(exc)}")
+        print(f"ERROR: {exc!s}")
         sys.exit(2)
 
     if len(inRemain) > 0:
@@ -147,45 +160,37 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
             print(helpMsg)
             sys.exit(0)
         elif inOpt in ("-v", "--version"):
-            print("novelWriter Version %s [%s]" % (__version__, __date__))
+            print(f"novelWriter Version {__version__} [{__date__}]")
             sys.exit(0)
-        elif inOpt == "--info":
+        elif inOpt in ("-i", "--info"):
             logLevel = logging.INFO
-        elif inOpt == "--debug":
+        elif inOpt in ("-d", "--debug"):
             CONFIG.isDebug = True
-            fmtFlags = fmtFlags | 0b10
+            fmtLong = True
             logLevel = logging.DEBUG
-        elif inOpt == "--color":
-            fmtFlags = fmtFlags | 0b01
+        elif inOpt in ("-c", "--color"):
+            fmtColor = not NO_COLOR
+        elif inOpt == "--meminfo":
+            CONFIG.memInfo = True
         elif inOpt == "--style":
             qtStyle = inArg
         elif inOpt == "--config":
             confPath = inArg
         elif inOpt == "--data":
             dataPath = inArg
-        elif inOpt == "--testmode":
-            testMode = True
-        elif inOpt == "--meminfo":
-            CONFIG.memInfo = True
 
-    if fmtFlags & 0b01:
+    if fmtColor:
         # This will overwrite the default level names, and also ensure that
         # they can be converted back to integer levels
-        logging.addLevelName(logging.DEBUG,    f"{C_BLUE}DEBUG{C_END}")
-        logging.addLevelName(logging.INFO,     f"{C_GREEN}INFO{C_END}")
-        logging.addLevelName(logging.WARNING,  f"{C_YELLOW}WARNING{C_END}")
-        logging.addLevelName(logging.ERROR,    f"{C_RED}ERROR{C_END}")
-        logging.addLevelName(logging.CRITICAL, f"{C_RED}CRITICAL{C_END}")
-
-    # Determine Log Format
-    if fmtFlags == 0b00:
-        logFmt = f"{L_LVLP}  {L_TEXT}"
-    elif fmtFlags == 0b01:
-        logFmt = f"{L_LVLC}  {L_TEXT}"
-    elif fmtFlags == 0b10:
-        logFmt = f"{L_TIME}  {L_FILE}:{L_LINE}  {L_LVLP}  {L_TEXT}"
-    elif fmtFlags == 0b11:
-        logFmt = f"{L_TIME}  {C_BLUE}{L_FILE}{C_END}:{C_WHITE}{L_LINE}{C_END}  {L_LVLC}  {L_TEXT}"
+        logging.addLevelName(logging.DEBUG,    f"{BLUE}DEBUG{END}")
+        logging.addLevelName(logging.INFO,     f"{GREEN}INFO{END}")
+        logging.addLevelName(logging.WARNING,  f"{YELLOW}WARNING{END}")
+        logging.addLevelName(logging.ERROR,    f"{RED}ERROR{END}")
+        logging.addLevelName(logging.CRITICAL, f"{RED}CRITICAL{END}")
+
+    logTxt = f"{LVLC}  {TEXT}" if fmtColor else f"{LVLP}  {TEXT}"
+    logPos = f"{BLUE}{FILE}{END}:{WHITE}{LINE}{END}" if fmtColor else f"{FILE}:{LINE}"
+    logFmt = f"{TIME}  {logPos}  {logTxt}" if fmtLong else logTxt
 
     # Setup Logging
     pkgLogger = logging.getLogger(__package__)
@@ -201,19 +206,19 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
     # Check Packages and Versions
     errorData = []
     errorCode = 0
-    if sys.hexversion < 0x030900f0:
+    if sys.hexversion < 0x030a00f0:
         errorData.append(
-            "At least Python 3.9 is required, found %s" % CONFIG.verPyString
+            f"At least Python 3.10 is required, found {CONFIG.verPyString}"
         )
         errorCode |= 0x04
-    if CONFIG.verQtValue < 0x050f00:
+    if CONFIG.verQtValue < 0x060400:
         errorData.append(
-            "At least Qt5 version 5.15.0 is required, found %s" % CONFIG.verQtString
+            f"At least Qt6 version 6.4 is required, found {CONFIG.verQtString}"
         )
         errorCode |= 0x08
-    if CONFIG.verPyQtValue < 0x050f00:
+    if CONFIG.verPyQtValue < 0x060400:
         errorData.append(
-            "At least PyQt5 version 5.15.0 is required, found %s" % CONFIG.verPyQtString
+            f"At least PyQt6 version 6.4 is required, found {CONFIG.verPyQtString}"
         )
         errorCode |= 0x10
 
@@ -224,9 +229,9 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
         errDlg.showMessage((
             "<h3>A critical error was encountered</h3>"
             "<p>novelWriter cannot start due to the following issues:<p>"
-            "<p>&nbsp;-&nbsp;%s</p>"
+            "<p>&nbsp;-&nbsp;{0}</p>"
             "<p>Shutting down ...</p>"
-        ) % (
+        ).format(
             "<br>&nbsp;-&nbsp;".join(errorData)
         ))
         for errLine in errorData:
@@ -254,29 +259,47 @@ def main(sysArgs: list | None = None) -> GuiMain | None:
             pass  # Quietly ignore error
 
     # Import GUI (after dependency checks), and launch
+    from novelwriter.gui.theme import GuiTheme
     from novelwriter.guimain import GuiMain
 
-    if testMode:
-        # Only used for testing where the test framework creates the app
-        CONFIG.loadConfig()
-        return GuiMain()
-
-    app = QApplication([CONFIG.appName, (f"-style={qtStyle}")])
-    app.setApplicationName(CONFIG.appName)
-    app.setApplicationVersion(__version__)
-    app.setOrganizationDomain(__domain__)
-    app.setOrganizationName(__domain__)
-    app.setDesktopFileName(CONFIG.appName)
+    # Create App
+    app = _createApp(qtStyle)
 
     # Connect the exception handler before making the main GUI
     sys.excepthook = exceptionHandler
 
+    splash = NSplashScreen()
+    splash.show()
+
+    splash.showStatus("")
+    splash.showStatus("Starting novelWriter ...")
+
     # Run Config steps that require the QApplication
-    CONFIG.loadConfig()
+    CONFIG.loadConfig(splash)
     CONFIG.initLocalisation(app)
+    SHARED.initTheme(GuiTheme())
 
     # Launch main GUI
     nwGUI = GuiMain()
+    nwGUI.showNormal()
+    splash.finish(nwGUI)
+
+    CONFIG.finishStartup()
+    del splash
+
     nwGUI.postLaunchTasks(cmdOpen)
 
     sys.exit(app.exec())
+
+
+def _createApp(style: str) -> QApplication:
+    """Create the app. This is done in a function to make it easier to
+    block app creation during testing.
+    """
+    app = QApplication([CONFIG.appName, f"-style={style}"])
+    app.setApplicationName(CONFIG.appName)
+    app.setApplicationVersion(__version__)
+    app.setOrganizationDomain(__domain__)
+    app.setOrganizationName(__domain__)
+    app.setDesktopFileName(CONFIG.appName)
+    return app

novelwriter/assets/i18n/project_de_DE.json

@@ -1,8 +1,10 @@
 {
-  "Synopsis": "Synopsis",
+  "Synopsis": "Zusammenfassung",
   "Short Description": "Kurzbeschreibung",
   "Footnotes": "Fußnoten",
   "Comment": "Kommentar",
+  "Story Structure": "Struktur",
+  "Note": "Notiz",
   "Notes": "Notizen",
   "Tag": "Schlagwort",
   "Point of View": "Perspektive",

novelwriter/assets/i18n/project_en_GB.json

@@ -3,6 +3,8 @@
   "Short Description": "Short Description",
   "Footnotes": "Footnotes",
   "Comment": "Comment",
+  "Story Structure": "Story Structure",
+  "Note": "Note",
   "Notes": "Notes",
   "Tag": "Tag",
   "Point of View": "Point of View",

novelwriter/assets/i18n/project_en_US.json

@@ -3,6 +3,8 @@
   "Short Description": "Short Description",
   "Footnotes": "Footnotes",
   "Comment": "Comment",
+  "Story Structure": "Story Structure",
+  "Note": "Note",
   "Notes": "Notes",
   "Tag": "Tag",
   "Point of View": "Point of View",

novelwriter/assets/i18n/project_it_IT.json

@@ -3,6 +3,8 @@
   "Short Description": "Breve descrizione",
   "Footnotes": "Note a piè pagina",
   "Comment": "Commento",
+  "Story Structure": "Struttura della storia",
+  "Note": "Nota",
   "Notes": "Note",
   "Tag": "Etichetta",
   "Point of View": "Punto di vista",

novelwriter/assets/i18n/project_ja_JP.json

@@ -3,6 +3,8 @@
   "Short Description": "短い説明",
   "Footnotes": "脚注",
   "Comment": "コメント ",
+  "Story Structure": "ストーリー構造",
+  "Note": "ノート",
   "Notes": "ノート",
   "Tag": "タグ",
   "Point of View": "視点",

novelwriter/assets/i18n/project_nb_NO.json

@@ -3,6 +3,8 @@
   "Short Description": "Kort beskrivelse",
   "Footnotes": "Fotnoter",
   "Comment": "Kommentar",
+  "Story Structure": "Tekst-element",
+  "Note": "Notat",
   "Notes": "Notat",
   "Tag": "Knagg",
   "Point of View": "Perspektiv",

novelwriter/assets/i18n/project_nn_NO.json

@@ -1,6 +1,10 @@
 {
   "Synopsis": "Samandrag",
+  "Short Description": "Kort beskriving",
+  "Footnotes": "Fotnotar",
   "Comment": "Kommentar",
+  "Story Structure": "Tekst-element",
+  "Note": "Notat",
   "Notes": "Notat",
   "Tag": "Knagg",
   "Point of View": "Perspektiv",
@@ -12,6 +16,7 @@
   "Objects": "Objekt",
   "Entities": "Eining",
   "Custom": "Anna",
+  "New Page": "Ny side",
   "0": "null",
   "1": "ein",
   "2": "to",

novelwriter/assets/i18n/project_pl_PL.json

@@ -3,6 +3,8 @@
   "Short Description": "Krótki opis",
   "Footnotes": "Przypisy",
   "Comment": "Komentarz",
+  "Story Structure": "Struktura opowieści",
+  "Note": "Notatka",
   "Notes": "Notatki",
   "Tag": "Znacznik",
   "Point of View": "Punkt widzenia",

novelwriter/assets/i18n/project_pt_BR.json

@@ -3,6 +3,8 @@
   "Short Description": "Descrição breve",
   "Footnotes": "Notas de rodapé",
   "Comment": "Comentário",
+  "Story Structure": "Estrutura narrativa",
+  "Note": "Nota",
   "Notes": "Notas",
   "Tag": "Etiqueta",
   "Point of View": "Ponto de vista",

novelwriter/assets/i18n/project_ru_RU.json

@@ -1,6 +1,7 @@
 {
   "Synopsis": "Сводка",
   "Short Description": "Краткое описание",
+  "Footnotes": "Примечания",
   "Comment": "Комментарий",
   "Notes": "Заметки",
   "Tag": "Тэг",
@@ -13,6 +14,7 @@
   "Objects": "Объекты",
   "Entities": "Сущности",
   "Custom": "Другое",
+  "New Page": "Новая страница",
   "0": "Ноль",
   "1": "Один",
   "2": "Два",

novelwriter/assets/i18n/project_zh_CN.json

@@ -3,6 +3,8 @@
   "Short Description": "简短描述",
   "Footnotes": "注释",
   "Comment": "注释",
+  "Story Structure": "故事结构",
+  "Note": "笔记",
   "Notes": "笔记",
   "Tag": "标签",
   "Point of View": "视角",