call task from poe

remove build.ps1 and scripts.py

CHANGELOG.md

@@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 -   [ ] 
 
+## [1.9.8] - 2025-01-22
+
+### Changed
+
+-   vm-compact config dirs now override _internal/configs (if using build from releases). See [TOML Files](https://github.com/onyx-and-iris/voicemeeter-compact?tab=readme-ov-file#toml-files) section in README.
+-   after disconnecting from a vban connection, vban menus are re-enabled after 500ms.
+
 ## [1.9.5] - 2024-07-03
 
 ### Changed

README.md

@@ -65,15 +65,18 @@ Set the kind of Voicemeeter, KIND_ID may be:
 
 ## TOML Files
 
-This is how your files should be organised. Wherever your `__main__.py` file is located (after install this can be any location), `configs` should be in the same location.
-Directly inside of configs directory you may place an app.toml, vban.toml and a directory for each kind.
-Inside each kind directory you may place as many custom toml configurations as you wish.
+If you've downloaded the binary from [Releases][releases] you can find configs included in the `_internal/configs` directory.
+
+You may override these configs by placing a directory `vm-compact` in one of the following locations:
+
+-   `user home directory / .config`
+-   `user home directory / Documents / Voicemeeter`
+
+The contents should match the following directory structure:
 
 .
 
-├── `__main__.py`
-
-├── configs
+├── vm-compact
 
         ├── app.toml
 
@@ -111,7 +114,7 @@ Configure certain startup states for the app.
     Configure a user config to load on app startup. Don't include the .toml extension in the config name.
 
 -   `theme`
-    By default the app loads up the [Sun Valley light or dark theme][def] by @rdbende. You have the option to load up the app without any theme loaded. Simply set `enabled` to false and `mode` will take no effect.
+    By default the app loads up the [Sun Valley light or dark theme][releases] by @rdbende. You have the option to load up the app without any theme loaded. Simply set `enabled` to false and `mode` will take no effect.
 
 -   `extends`
     Extending the app will show both strips and buses. In reduced mode only one or the other. This app will extend both horizontally and vertically, simply set `extends_horizontal` true or false accordingly.
@@ -164,4 +167,5 @@ User configs may be loaded at any time via the menu.
 [Rdbende](https://github.com/rdbende) for creating the beautiful [Sun Valley theme][sv-theme].
 
 
-[sv-theme]: https://github.com/rdbende/Sun-Valley-ttk-theme
+[sv-theme]: https://github.com/rdbende/Sun-Valley-ttk-theme
+[releases]: https://github.com/onyx-and-iris/voicemeeter-compact/releases

Taskfile.yml

@@ -0,0 +1,81 @@
+version: '3'
+
+vars:
+  SHELL: pwsh
+
+tasks:
+  default:
+    desc: Prepare artifacts for release
+    cmds:
+      - task: release
+
+  release:
+    desc: Build and compress all artifacts
+    cmds:
+      - task: build
+      - task: compress
+      - echo "Release complete"
+
+  build:
+    desc: Build all artifacts
+    cmds:
+      - task: build-sunvalley
+      - echo "Sunvalley build complete"
+      - task: build-forest
+      - echo "Forest build complete"
+
+  build-sunvalley:
+    desc: Build Sunvalley artifacts
+    cmds:
+      - for:
+          matrix:
+            KIND: [basic, banana, potato]
+        cmd: poetry run pyinstaller --noconfirm --distpath dist/sunvalley-{{.ITEM.KIND}} spec/sunvalley-{{.ITEM.KIND}}.spec
+
+  build-forest:
+    desc: Build Forest artifacts
+    deps: [rewrite]
+    cmds:
+      - defer: { task: restore }
+      - for:
+          matrix:
+            KIND: [basic, banana, potato]
+            THEME: [light, dark]
+        cmd: poetry run pyinstaller --noconfirm --distpath dist/forest-{{.ITEM.KIND}}-{{.ITEM.THEME}} spec/forest-{{.ITEM.KIND}}-{{.ITEM.THEME}}.spec
+
+  rewrite:
+    internal: true
+    desc: Run the source code rewriter
+    cmds:
+      - poetry run python tools/rewriter.py --rewrite
+
+  restore:
+    internal: true
+    desc: Restore the backup files
+    cmds:
+      - poetry run python tools/rewriter.py --restore
+
+  compress:
+    deps: [compress-sunvalley, compress-forest]
+
+  compress-sunvalley:
+    cmds:
+      - for:
+          matrix:
+            KIND: [basic, banana, potato]
+        cmd: '{{.SHELL}} -Command "Compress-Archive -Path dist/sunvalley-{{.ITEM.KIND}} -DestinationPath dist/sunvalley-{{.ITEM.KIND}}.zip -Force"'
+
+  compress-forest:
+    cmds:
+      - for:
+          matrix:
+            KIND: [basic, banana, potato]
+            THEME: [light, dark]
+        cmd: '{{.SHELL}} -Command "Compress-Archive -Path dist/forest-{{.ITEM.KIND}}-{{.ITEM.THEME}} -DestinationPath dist/forest-{{.ITEM.KIND}}-{{.ITEM.THEME}}.zip -Force"'
+
+  clean:
+    desc: Clean up build and dist directories
+    cmds:
+      - |
+        {{.SHELL}} -Command "
+          Remove-Item -Path build/forest-*,build/sunvalley-*,dist/forest-*,dist/sunvalley-* -Recurse -Force"

build.ps1

@@ -1,41 +0,0 @@
-param(
-    [Parameter(Mandatory = $true)]
-    [string]$prefix,
-    [string]$theme
-)
-
-function Format-SpecName {
-    param(
-        [string]$Kind
-    )
-    return @(
-        $prefix,
-        (& { if ($theme) { $theme } else { "" } }),
-        $Kind
-    ).Where({ $_ -ne "" }) -Join "_"
-}
-
-function Compress-Builds {
-    $target = Join-Path -Path $PSScriptRoot -ChildPath "dist"
-    @("basic", "banana", "potato") | ForEach-Object {
-        $compressPath = Format-SpecName -Kind $_
-        Compress-Archive -Path (Join-Path -Path $target -ChildPath $compressPath) -DestinationPath (Join-Path -Path $target -ChildPath "${compressPath}.zip") -Force
-    } 
-}
-
-function Get-Builds {
-    @("basic", "banana", "potato") | ForEach-Object {
-        $specName = Format-SpecName -Kind $_
-
-        Write-Host "building $specName"
-
-        poetry run pyinstaller --noconfirm --distpath (Join-Path -Path "dist" -ChildPath $specName) (Join-Path -Path "spec" -ChildPath "${specName}.spec")
-    }
-}
-
-function main {
-    Get-Builds
-    Compress-Builds
-}
-
-if ($MyInvocation.InvocationName -ne '.') { main }

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "voicemeeter-compact"
-version = "1.9.7"
+version = "1.9.8"
 description = "A Compact Voicemeeter Remote App"
 authors = [
     {name = "Onyx and Iris",email = "code@onyxandiris.online"}
@@ -16,9 +16,9 @@ dependencies = [
 ]
 
 [project.scripts]
-gui-basic = "vmcompact.gui.basic:run"
-gui-banana = "vmcompact.gui.banana:run"
-gui-potato = "vmcompact.gui.potato:run"
+gui-basic-compact = "vmcompact.gui.basic:run"
+gui-banana-compact = "vmcompact.gui.banana:run"
+gui-potato-compact = "vmcompact.gui.potato:run"
 
 [tool.poetry]
 packages = [{ include = "vmcompact" }]
@@ -38,9 +38,14 @@ requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poe.tasks]
-build_sunvalley.script = "scripts:build_sunvalley"
-build_forest.script = "scripts:build_forest"
-build_all.script = "scripts:build_all"
+build-sunvalley = "task build-sunvalley"
+build-forest = "task build-forest"
+release = [
+  { ref = "build-sunvalley" },
+  { ref = "build-forest" },
+  { cmd = "task compress-sunvalley" },
+  { cmd = "task compress-forest" },
+]
 
 [tool.ruff]
 exclude = [

scripts.py

@@ -1,24 +0,0 @@
-import subprocess
-import sys
-from pathlib import Path
-
-
-def build_sunvalley():
-    buildscript = Path.cwd() / "build.ps1"
-    subprocess.run(["powershell", str(buildscript), "sv"])
-
-
-def build_forest():
-    rewriter = Path.cwd() / "tools" / "rewriter.py"
-    subprocess.run([sys.executable, str(rewriter), "-r"])
-
-    buildscript = Path.cwd() / "build.ps1"
-    for theme in ("light", "dark"):
-        subprocess.run(["powershell", str(buildscript), "fst", theme])
-
-    subprocess.run([sys.executable, str(rewriter), "-c"])
-
-
-def build_all():
-    steps = (build_sunvalley, build_forest)
-    [step() for step in steps]

tools/rewriter.py

@@ -4,11 +4,11 @@ from pathlib import Path
 
 logging.basicConfig(level=logging.DEBUG)
 
-logger = logging.getLogger("vm-compact-rewriter")
+logger = logging.getLogger('vm-compact-rewriter')
 
-PACKAGE_DIR = Path(__file__).parent.parent / "vmcompact"
+PACKAGE_DIR = Path(__file__).parent.parent / 'vmcompact'
 
-SRC_DIR = Path(__file__).parent / "src"
+SRC_DIR = Path(__file__).parent / 'src'
 
 
 def write_outs(output, outs: tuple):
@@ -17,183 +17,183 @@ def write_outs(output, outs: tuple):
 
 
 def rewrite_app():
-    app_logger = logger.getChild("app")
-    app_logger.info("rewriting app.py")
-    infile = Path(SRC_DIR) / "app.bk"
-    outfile = Path(PACKAGE_DIR) / "app.py"
-    with open(infile, "r") as input:
-        with open(outfile, "w") as output:
+    app_logger = logger.getChild('app')
+    app_logger.info('rewriting app.py')
+    infile = Path(SRC_DIR) / 'app.bk'
+    outfile = Path(PACKAGE_DIR) / 'app.py'
+    with open(infile, 'r') as input:
+        with open(outfile, 'w') as output:
             for line in input:
                 match line:
                     # App init()
-                    case "    def __init__(self, vmr):\n":
-                        output.write("    def __init__(self, vmr, theme):\n")
-                    case "        self._vmr = vmr\n":
+                    case '    def __init__(self, vmr):\n':
+                        output.write('    def __init__(self, vmr, theme):\n')
+                    case '        self._vmr = vmr\n':
                         write_outs(
                             output,
                             (
-                                "        self._vmr = vmr\n",
-                                "        self._theme = theme\n",
+                                '        self._vmr = vmr\n',
+                                '        self._theme = theme\n',
                                 '        tcldir = Path.cwd() / "theme"\n',
-                                "        if not tcldir.is_dir():\n",
+                                '        if not tcldir.is_dir():\n',
                                 '            tcldir = Path.cwd() / "_internal" / "theme"\n',
                                 '        self.tk.call("source", tcldir.resolve() / f"forest-{self._theme}.tcl")\n',
                             ),
                         )
                     # def connect()
-                    case "def connect(kind_id: str, vmr) -> App:\n":
+                    case 'def connect(kind_id: str, vmr) -> App:\n':
                         output.write(
                             'def connect(kind_id: str, vmr, theme="light") -> App:\n'
                         )
-                    case "    return VMMIN_cls(vmr)\n":
-                        output.write("    return VMMIN_cls(vmr, theme)\n")
+                    case '    return VMMIN_cls(vmr)\n':
+                        output.write('    return VMMIN_cls(vmr, theme)\n')
                     case _:
                         output.write(line)
 
 
 def rewrite_builders():
-    builders_logger = logger.getChild("builders")
-    builders_logger.info("rewriting builders.py")
-    infile = Path(SRC_DIR) / "builders.bk"
-    outfile = Path(PACKAGE_DIR) / "builders.py"
-    with open(infile, "r") as input:
-        with open(outfile, "w") as output:
+    builders_logger = logger.getChild('builders')
+    builders_logger.info('rewriting builders.py')
+    infile = Path(SRC_DIR) / 'builders.bk'
+    outfile = Path(PACKAGE_DIR) / 'builders.py'
+    with open(infile, 'r') as input:
+        with open(outfile, 'w') as output:
             ignore_next_lines = 0
 
             for line in input:
                 if ignore_next_lines > 0:
-                    builders_logger.info(f"ignoring: {line}")
+                    builders_logger.info(f'ignoring: {line}')
                     ignore_next_lines -= 1
                     continue
 
                 match line:
                     # loading themes
-                    case "import sv_ttk\n":
-                        output.write("#import sv_ttk\n")
-                    case "        self.app.resizable(False, False)\n":
+                    case 'import sv_ttk\n':
+                        output.write('#import sv_ttk\n')
+                    case '        self.app.resizable(False, False)\n':
                         write_outs(
                             output,
                             (
-                                "        self.app.resizable(False, False)\n"
-                                "        if _configuration.themes_enabled:\n",
+                                '        self.app.resizable(False, False)\n'
+                                '        if _configuration.themes_enabled:\n',
                                 '            ttk.Style().theme_use(f"forest-{self.app._theme}")\n',
                                 '            self.logger.info(f"Forest Theme applied")\n',
                             ),
                         )
                         ignore_next_lines = 6
                     # setting navframe button widths
-                    case "            variable=self.navframe.submix,\n":
+                    case '            variable=self.navframe.submix,\n':
                         write_outs(
                             output,
                             (
-                                "            variable=self.navframe.submix,\n"
-                                "            width=8,\n",
+                                '            variable=self.navframe.submix,\n'
+                                '            width=8,\n',
                             ),
                         )
-                    case "            variable=self.navframe.channel,\n":
+                    case '            variable=self.navframe.channel,\n':
                         write_outs(
                             output,
                             (
-                                "            variable=self.navframe.channel,\n"
-                                "            width=8,\n",
+                                '            variable=self.navframe.channel,\n'
+                                '            width=8,\n',
                             ),
                         )
-                    case "            variable=self.navframe.extend,\n":
+                    case '            variable=self.navframe.extend,\n':
                         write_outs(
                             output,
                             (
-                                "            variable=self.navframe.extend,\n"
-                                "            width=8,\n",
+                                '            variable=self.navframe.extend,\n'
+                                '            width=8,\n',
                             ),
                         )
-                    case "            variable=self.navframe.info,\n":
+                    case '            variable=self.navframe.info,\n':
                         write_outs(
                             output,
                             (
-                                "            variable=self.navframe.info,\n"
-                                "            width=8,\n",
+                                '            variable=self.navframe.info,\n'
+                                '            width=8,\n',
                             ),
                         )
                     # set channelframe button widths
-                    case "            variable=self.labelframe.mute,\n":
+                    case '            variable=self.labelframe.mute,\n':
                         write_outs(
                             output,
                             (
-                                "            variable=self.labelframe.mute,\n"
-                                "            width=7,\n",
+                                '            variable=self.labelframe.mute,\n'
+                                '            width=7,\n',
                             ),
                         )
-                    case "            variable=self.labelframe.conf,\n":
+                    case '            variable=self.labelframe.conf,\n':
                         write_outs(
                             output,
                             (
-                                "            variable=self.labelframe.conf,\n"
-                                "            width=7,\n",
+                                '            variable=self.labelframe.conf,\n'
+                                '            width=7,\n',
                             ),
                         )
-                    case "            variable=self.labelframe.on,\n":
+                    case '            variable=self.labelframe.on,\n':
                         write_outs(
                             output,
                             (
-                                "            variable=self.labelframe.on,\n"
-                                "            width=7,\n",
+                                '            variable=self.labelframe.on,\n'
+                                '            width=7,\n',
                             ),
                         )
                     # set stripconfigframe button widths
-                    case "                    self.configframe.phys_out_params.index(param)\n":
+                    case '                    self.configframe.phys_out_params.index(param)\n':
                         write_outs(
                             output,
                             (
-                                "                    self.configframe.phys_out_params.index(param)\n",
-                                "                ],\n",
-                                "                width=6,\n",
+                                '                    self.configframe.phys_out_params.index(param)\n',
+                                '                ],\n',
+                                '                width=6,\n',
                             ),
                         )
                         ignore_next_lines = 1
-                    case "                    self.configframe.virt_out_params.index(param)\n":
+                    case '                    self.configframe.virt_out_params.index(param)\n':
                         write_outs(
                             output,
                             (
-                                "                    self.configframe.virt_out_params.index(param)\n",
-                                "                ],\n",
-                                "                width=6,\n",
+                                '                    self.configframe.virt_out_params.index(param)\n',
+                                '                ],\n',
+                                '                width=6,\n',
                             ),
                         )
                         ignore_next_lines = 1
                     # This does both strip and bus param vars buttons
-                    case "                variable=self.configframe.param_vars[i],\n":
+                    case '                variable=self.configframe.param_vars[i],\n':
                         write_outs(
                             output,
                             (
-                                "                variable=self.configframe.param_vars[i],\n",
-                                "                width=6,\n",
+                                '                variable=self.configframe.param_vars[i],\n',
+                                '                width=6,\n',
                             ),
                         )
                     case _:
-                        if "Toggle.TButton" in line:
-                            output.write(line.replace("Toggle.TButton", "ToggleButton"))
+                        if 'Toggle.TButton' in line:
+                            output.write(line.replace('Toggle.TButton', 'ToggleButton'))
                         else:
                             output.write(line)
 
 
 def rewrite_menu():
-    menu_logger = logger.getChild("menu")
-    menu_logger.info("rewriting menu.py")
-    infile = Path(SRC_DIR) / "menu.bk"
-    outfile = Path(PACKAGE_DIR) / "menu.py"
-    with open(infile, "r") as input:
-        with open(outfile, "w") as output:
+    menu_logger = logger.getChild('menu')
+    menu_logger.info('rewriting menu.py')
+    infile = Path(SRC_DIR) / 'menu.bk'
+    outfile = Path(PACKAGE_DIR) / 'menu.py'
+    with open(infile, 'r') as input:
+        with open(outfile, 'w') as output:
             ignore_next_lines = 0
 
             for line in input:
                 if ignore_next_lines > 0:
-                    menu_logger.info(f"ignoring: {line}")
+                    menu_logger.info(f'ignoring: {line}')
                     ignore_next_lines -= 1
                     continue
                 match line:
-                    case "import sv_ttk\n":
-                        output.write("#import sv_ttk\n")
-                    case "        # layout/themes\n":
+                    case 'import sv_ttk\n':
+                        output.write('#import sv_ttk\n')
+                    case '        # layout/themes\n':
                         ignore_next_lines = 14
                     case _:
                         output.write(line)
@@ -202,13 +202,13 @@ def rewrite_menu():
 def prepare_for_build():
     ################# MOVE FILES FROM PACKAGE DIR INTO SRC DIR #########################
     for file in (
-        PACKAGE_DIR / "app.py",
-        PACKAGE_DIR / "builders.py",
-        PACKAGE_DIR / "menu.py",
+        PACKAGE_DIR / 'app.py',
+        PACKAGE_DIR / 'builders.py',
+        PACKAGE_DIR / 'menu.py',
     ):
         if file.exists():
-            logger.debug(f"moving {str(file)}")
-            file.rename(SRC_DIR / f"{file.stem}.bk")
+            logger.debug(f'moving {str(file)}')
+            file.rename(SRC_DIR / f'{file.stem}.bk')
 
     ###################### RUN THE FILE REWRITER FOR EACH *.BK #########################
     steps = (
@@ -222,29 +222,29 @@ def prepare_for_build():
 def cleanup():
     ########################## RESTORE *.BK FILES #####################################
     for file in (
-        PACKAGE_DIR / "app.py",
-        PACKAGE_DIR / "builders.py",
-        PACKAGE_DIR / "menu.py",
+        PACKAGE_DIR / 'app.py',
+        PACKAGE_DIR / 'builders.py',
+        PACKAGE_DIR / 'menu.py',
     ):
         file.unlink()
 
     for file in (
-        SRC_DIR / "app.bk",
-        SRC_DIR / "builders.bk",
-        SRC_DIR / "menu.bk",
+        SRC_DIR / 'app.bk',
+        SRC_DIR / 'builders.bk',
+        SRC_DIR / 'menu.bk',
     ):
-        file.rename(PACKAGE_DIR / f"{file.stem}.py")
+        file.rename(PACKAGE_DIR / f'{file.stem}.py')
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     parser = argparse.ArgumentParser()
-    parser.add_argument("-r", "--rewrite", action="store_true")
-    parser.add_argument("-c", "--cleanup", action="store_true")
+    parser.add_argument('--rewrite', action='store_true')
+    parser.add_argument('--restore', action='store_true')
     args = parser.parse_args()
 
     if args.rewrite:
-        logger.info("preparing files for build")
+        logger.info('preparing files for build')
         prepare_for_build()
-    elif args.cleanup:
-        logger.info("cleaning up files")
+    elif args.restore:
+        logger.info('cleaning up files')
         cleanup()

vmcompact/configurations.py

@@ -12,14 +12,14 @@ configuration = {}
 
 
 def get_configpath():
-    configpaths = [
+    for pn in (
+        Path.home() / '.config' / 'vm-compact',
+        Path.home() / 'Documents' / 'Voicemeeter' / 'vm-compact',
+        Path.cwd() / '_internal' / 'configs',
         Path.cwd() / 'configs',
-        Path.home() / '.config' / 'vm-compact' / 'configs',
-        Path.home() / 'Documents' / 'Voicemeeter' / 'configs',
-    ]
-    for configpath in configpaths:
-        if configpath.exists():
-            return configpath
+    ):
+        if pn.exists():
+            return pn
 
 
 if configpath := get_configpath():

vmcompact/menu.py

@@ -421,7 +421,7 @@ class Menus(tk.Menu):
             del self.parent.__dict__['userconfigs']
         self.menu_setup()
 
-        self.after(15000, self.enable_vban_menus)
+        self.after(500, self.enable_vban_menus)
 
     def documentation(self):
         webbrowser.open_new(r'https://voicemeeter.com/')