Merge pull request #48 from beeware/console-app

Modify stub handling to allow for console and GUI stubs

.github/workflows/update-binary.yml

@@ -53,14 +53,15 @@ jobs:
         # Generate the stub app
         cd stub
         briefcase build windows visualstudio
-        echo "Move the binary into the final location"
-        mv ./build/stub/windows/visualstudio/x64/Release/Stub.exe ./Stub-${{ env.PYTHON_TAG }}.exe
+        echo "Move the binaries into the final location"
+        mv ./build/console-stub/windows/visualstudio/x64/Release/console-stub.exe ./Console-Stub-${{ env.PYTHON_TAG }}.exe
+        mv "./build/gui-stub/windows/visualstudio/x64/Release/GUI stub.exe" ./GUI-Stub-${{ env.PYTHON_TAG }}.exe
 
     - name: Upload Stub Artefact
       uses: actions/[email protected]
       with:
         name: stub-${{ matrix.python-version }}
-        path: stub/Stub-${{ env.PYTHON_TAG }}.exe
+        path: stub/*-Stub-${{ env.PYTHON_TAG }}.exe
 
   commit-stubs:
     name: Commit Stub Binaries
@@ -75,23 +76,15 @@ jobs:
         export BRIEFCASE_VERSION="${TAG%-*}"
         export BUILD_NUMBER="${TAG#*-}"
 
-        echo "TAG=${TAG}"
-        echo "PYTHON_TAG=${PYTHON_TAG}"
-        echo "BRIEFCASE_VERSION=${BRIEFCASE_VERSION}"
-        echo "BUILD_NUMBER=${BUILD_NUMBER}"
-
-        echo "TAG=${TAG}" >> $GITHUB_ENV
-        echo "PYTHON_TAG=${PYTHON_TAG}" >> $GITHUB_ENV
-        echo "BRIEFCASE_VERSION=${BRIEFCASE_VERSION}" >> $GITHUB_ENV
-        echo "BUILD_NUMBER=${BUILD_NUMBER}" >> $GITHUB_ENV
+        echo "TAG=${TAG}" | tee -a $GITHUB_ENV
+        echo "BRIEFCASE_VERSION=${BRIEFCASE_VERSION}" | tee -a $GITHUB_ENV
+        echo "BUILD_NUMBER=${BUILD_NUMBER}" | tee -a $GITHUB_ENV
 
         if [ "${BRIEFCASE_VERSION}" == "dev" ]; then
           # We're on the development template; push to main
-          echo "TEMPLATE_BRANCH=main"
-          echo "TEMPLATE_BRANCH=main" >> $GITHUB_ENV
+          echo "TEMPLATE_BRANCH=main" | tee -a $GITHUB_ENV
         else
-          echo "TEMPLATE_BRANCH=v${BRIEFCASE_VERSION}"
-          echo "TEMPLATE_BRANCH=v${BRIEFCASE_VERSION}" >> $GITHUB_ENV
+          echo "TEMPLATE_BRANCH=v${BRIEFCASE_VERSION}" | tee -a $GITHUB_ENV
         fi
 
     - name: Checkout Template
@@ -108,8 +101,8 @@ jobs:
       run: |
         git config user.email "[email protected]"
         git config user.name "Brutus (robot)"
-        # Move the binary into it's final location
-        mv stub/Stub-* "{{ cookiecutter.format }}/src"
+        # Move the binaries into their final location
+        mv stub/*-Stub-* "{{ cookiecutter.format }}/src"
         git add "{{ cookiecutter.format }}/src"
         git commit -m "AUTO: Update app binaries; build ${{ env.TAG }}"
         git push origin HEAD:${{ env.TEMPLATE_BRANCH }}

cookiecutter.json

@@ -3,16 +3,19 @@
     "formal_name": "App Name",
     "app_name": "{{ cookiecutter.formal_name|lower|replace(' ', '-') }}",
     "module_name": "{{ cookiecutter.app_name|replace('-', '_') }}",
+    "bundle": "com.example",
     "version_triple": "0.0.1",
     "author": "Example Corporation",
     "author_email": "[email protected]",
     "url": "http://example.com",
     "description": "Short description of app",
+    "console_app": false,
     "guid": "1409c8f5-c276-4cf3-a2fd-defcbdfef9a2",
     "install_scope": "",
     "use_full_install_path": true,
     "python_version": "3.X.0",
     "_extensions": [
-        "briefcase.integrations.cookiecutter.PythonVersionExtension"
+        "briefcase.integrations.cookiecutter.PythonVersionExtension",
+        "briefcase.integrations.cookiecutter.UUIDExtension"
     ]
 }

hooks/post_gen_project.py

@@ -4,9 +4,12 @@
 
 BIN_PATH = Path("src")
 
-# Move the stub for the Python version into the final location
-os.rename(BIN_PATH / 'Stub-{{ cookiecutter.python_version|py_tag }}.exe', BIN_PATH / '{{ cookiecutter.formal_name }}.exe')
+# Rename the stub binary we want
+STUB_PATH = (
+    BIN_PATH / '{% if cookiecutter.console_app %}Console{% else %}GUI{% endif %}-Stub-{{ cookiecutter.python_version|py_tag }}.exe'
+)
+STUB_PATH.rename(BIN_PATH / "Stub.exe")
 
 # Delete all remaining stubs
-for stub in BIN_PATH.glob("Stub-*.exe"):
+for stub in BIN_PATH.glob("*-Stub-*.exe"):
     os.unlink(stub)

stub/pyproject.toml

@@ -2,8 +2,15 @@
 project_name = "Stub"
 bundle = "org.beeware"
 version = "1.0.0"
+license.file = "../LICENSE"
 
-[tool.briefcase.app.stub]
-formal_name = "Stub"
-description = "A stub binary that can be integrated into the Windows app template"
-sources = ['src/stub']
+[tool.briefcase.app.gui-stub]
+formal_name = "GUI Stub"
+description = "A stub binary for GUI apps that can be integrated into the Windows app template"
+sources = ['src/gui_stub']
+
+[tool.briefcase.app.console-stub]
+formal_name = "Console Stub"
+description = "A stub binary for console apps that can be integrated into the Windows app template"
+sources = ['src/console_stub']
+console_app = true

{{ cookiecutter.format }}/{{ cookiecutter.app_name }}.wxs

@@ -63,7 +63,14 @@
                 <Directory Id="{{ cookiecutter.module_name }}_ROOTDIR" Name="{{ cookiecutter.formal_name }}" />
             {%- endif %}
             </Directory>
-
+            {% if cookiecutter.console_app %}
+            <Component Id="SystemPathEnv" Guid="{{ ".".join(["system-path", cookiecutter.app_name] + cookiecutter.bundle.split(".")[::-1])|dns_uuid5 }}">
+                <Environment Id="AppendSystemPathEnvValue" Name="PATH" Action="set" Part="last" System="yes" Value="[{{ cookiecutter.module_name }}_ROOTDIR]" Permanent="no" />
+            </Component>
+            <Component Id="UserPathEnv" Guid="{{ ".".join(["user-path", cookiecutter.app_name] + cookiecutter.bundle.split(".")[::-1])|dns_uuid5 }}">
+                <Environment Id="AppendUserPathEnvValue" Name="PATH" Action="set" Part="last" System="no" Value="[{{ cookiecutter.module_name }}_ROOTDIR]" Permanent="no" />
+            </Component>
+            {% endif %}
             <Directory Id="ProgramMenuFolder">
                 <Directory Id="ProgramMenuSubfolder" Name="{{ cookiecutter.formal_name }}">
                     <Component
@@ -76,7 +83,7 @@
                                 Name="{{ cookiecutter.formal_name }}"
                                 Icon="ProductIcon"
                                 Description="{{ cookiecutter.description }}"
-                                Target="[{{ cookiecutter.module_name }}_ROOTDIR]{{ cookiecutter.formal_name }}.exe"
+                                Target="[{{ cookiecutter.module_name }}_ROOTDIR]{% if cookiecutter.console_app %}{{ cookiecutter.app_name }}{% else %}{{ cookiecutter.formal_name }}{% endif %}.exe"
                         />
                         <RegistryValue
                                 Root="HKCU"
@@ -99,7 +106,16 @@
             <ComponentGroupRef Id="{{ cookiecutter.module_name }}_COMPONENTS" />
             <ComponentRef Id="ApplicationShortcuts"/>
         </Feature>
-
+        {% if cookiecutter.console_app %}
+        <Feature Id="SystemPathEnvFeature" Level="1">
+            <Condition Level="0">ALLUSERS=2 OR MSIINSTALLPERUSER=1</Condition>
+            <ComponentRef Id="SystemPathEnv"/>
+        </Feature>
+        <Feature Id="UserPathEnvFeature" Level="1">
+            <Condition Level="0">ALLUSERS=1</Condition>
+            <ComponentRef Id="UserPathEnv"/>
+        </Feature>
+        {% endif %}
         <WixVariable Id="WixUISupportPerUser" Value="1" Overridable="yes" />
         <WixVariable Id="WixUISupportPerMachine" Value="1" Overridable="yes" />