Merge branch 'imgui_bundle'

Author: dcnieho

.github/workflow_data/release.py

@@ -1,4 +1,4 @@
-name: Build executables and publish 📦 to PyPI
+name: Publish Python 🐍 distributions 📦 to PyPI
 
 on:
   workflow_dispatch:
@@ -7,135 +7,6 @@ on:
       - "published"
 
 jobs:
-  build:
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - "windows-latest"
-          #- "macos-latest"
-          #- "ubuntu-latest"
-        python:
-          - "3.10.x"
-        cx-freeze:
-          - "v6.13.1"
-    name: "Build exe for ${{ matrix.os }}"
-    runs-on: "${{ matrix.os }}"
-    steps:
-
-      # === SETUP ===
-
-      - name: "Setup python"
-        uses: "actions/setup-python@v4"
-        with:
-          python-version: "${{ matrix.python }}"
-
-      - name: "Install cx_Freeze bootloader"
-        run: |
-          python -m pip install cx_Freeze==${{ matrix.cx-freeze }}
-
-      # === BUILD ===
-
-      - name: "Clone repo"
-        uses: "actions/checkout@v3"
-        with:
-          path: "./src/"
-
-      - name: "Install requirements"
-        run: |
-          cd ./src/
-          python -m pip install -U numpy
-          python -m pip install -U -r ./requirements.txt
-
-      - name: "Build"
-        if: "runner.os != 'macOS'"
-        run: |
-          cd ./src/
-          python ./buildGUI.py build
-          mv ./build/*/ ./dist/
-
-      - name: "Build macOS"
-        if: "runner.os == 'macOS'"
-        run: |
-          cd ./src/
-          python ./buildGUI.py bdist_mac
-          mkdir ./dist/
-          mv ./build/*.app/ ./dist/
-
-      - name: "Resolve symlinks"
-        if: "runner.os != 'Windows'"
-        run: |
-          cd ./src/dist/
-          find ./ -type l -exec echo Resolving {} \; -exec sed -i '' {} \;
-
-      # export Apple development certificate from Xcode: https://help.apple.com/xcode/mac/current/#/dev154b28f09
-      # base64 CERTIFICATE.p12 | pbcopy -> secrets.CODESIGN_P12_BASE64
-      - name: "Import macOS codesign certificate"
-        if: "runner.os == 'macOS'"
-        uses: "apple-actions/import-codesign-certs@v1"
-        with:
-          p12-file-base64: "${{ secrets.CODESIGN_P12_BASE64 }}"
-          p12-password: "${{ secrets.CODESIGN_P12_PASSWORD }}"
-
-      # security find-identity, returns something like:
-      # A30C8432FADE0B3E7D5BA54034EF2ECA39A0BDD0 "Apple Development: [email protected] (6LR9J7UR6F)"
-      # the first hex string is your identity -> secrets.CODESIGN_P12_NAME
-      - name: "Codesign macOS"
-        if: "runner.os == 'macOS'"
-        run: |
-          cd ./src/dist/
-          find ./ -type f -empty -delete
-          codesign -s "${{ secrets.CODESIGN_P12_NAME }}" --deep -f ./*.app
-
-      # === ARTIFACT ===
-
-      - name: "Zip artifact"
-        run: |
-          7z a -r ./${{ github.event.repository.name }}-${{ runner.os }}.zip ./src/dist/*
-
-      - name: "Upload release artifact"
-        uses: "softprops/action-gh-release@v1"
-        env:
-          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-        with:
-          files: "./${{ github.event.repository.name }}-${{ runner.os }}.zip"
-
-
-  source:
-    name: Package 📦 source
-    runs-on: ubuntu-latest
-    steps:
-
-      # === PACKAGE ===
-
-      - name: Clone repo
-        uses: actions/checkout@v3
-        with:
-          path: "./src"
-
-      - name: Package 📦
-        run: |
-          cd    ./src/
-          mkdir ./dist/
-          cp -r ./src/             ./dist/
-          cp    ./LICENSE          ./dist/
-          cp    ./main.py          ./dist/
-          cp    ./requirements.txt ./dist/
-
-      # === ARTIFACT ===
-
-      - name: Zip artifact
-        run: |
-          7z a -r ./${{ github.event.repository.name }}-Source.zip ./src/dist/*
-
-      - name: Upload release artifact
-        uses: softprops/action-gh-release@v1
-        env:
-          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-        with:
-          files: "./${{ github.event.repository.name }}-Source.zip"
-
-
   wheel:
     name: Package 📦 wheel
     runs-on: ubuntu-latest
@@ -156,7 +27,7 @@ jobs:
         build
         --user
 
-    - name: Build a binary wheel and a source tarball
+    - name: Build a wheel and a source tarball
       run: >-
         python -m
         build
@@ -171,49 +42,8 @@ jobs:
       with:
         files: "./dist/*.whl"
 
-    - name: Upload as action artifact as well
-      uses: actions/upload-artifact@v3
+    - name: Publish distribution 📦 to PyPI
+      if: github.event_name == 'release' && github.event.action == 'published'
+      uses: pypa/gh-action-pypi-publish@master
       with:
-        name: wheel
-        path: ./dist/
-
-        
-  publish-wheel:
-    name: Publish wheel 📦 to PyPI
-    runs-on: ubuntu-latest
-    needs:
-      - wheel
-    steps:
-    
-    - name: Download wheel
-      uses: actions/download-artifact@v3
-      with:
-        name: wheel
-        path: ./dist/
-
-    - name: Publish wheel
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        password: ${{ secrets.PYPI_API_TOKEN }}
-
-
-  release:
-    name: "add artifacts to release"
-    runs-on: "ubuntu-latest"
-    needs:
-      - build
-      - source
-      - wheel
-    steps:
-
-      - name: "Clone repo"
-        uses: "actions/checkout@v3"
-        with:
-          path: "./src"
-
-      - name: "Update release"
-        env:
-          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-        run: |
-          cd ./src/
-          python ./.github/workflow_data/release.py
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/build.yml

@@ -20,8 +20,8 @@ __pycache__/
 *.so
 
 # virtual environment
-venv/
-build_venv/
+.venv/
+.build_venv/
 
 # Distribution / packaging
 .Python
@@ -45,3 +45,5 @@ MANIFEST
 # IDEs
 .idea/
 .vs/
+imgui.ini
+imgui_app_window.ini

.gitignore

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: main.py",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}\\main.py",
+            "console": "integratedTerminal",
+            "justMyCode": true
+        }
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,4 @@
+{
+    "python.analysis.typeCheckingMode": "off",
+    "explorer.excludeGitIgnore": true
+}

.vscode/settings.json

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Diederick Niehorster
+Copyright (c) 2022-2023 Diederick Niehorster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -8,26 +8,23 @@ glassesValidator. Please provide us with feedback on *anything* you notice, *no
 A preliminary reference to the upcoming paper is:<br>
 Niehorster, D.C., Hessels, R.S., Benjamins, J.S., Nyström, M. and Hooge, I.T.C. (submitted). GlassesValidator:
 A data quality tool for eye tracking glasses.
- 
+
 However, as long as the paper is not accepted, please cite this work as follows:<br>
 Niehorster, D.C., Hessels, R.S., Benjamins, J.S., Nyström, M. and Hooge, I.T.C. (2022). GlassesValidator:
 A data quality tool for eye tracking glasses. Available from https://github.com/dcnieho/glassesValidator
 
 # How to acquire
 The glassesValidator is available from `https://github.com/dcnieho/glassesValidator`, and supports Windows, MacOS and Linux.
-For Windows ~~and MacOS users~~ who wish to use the glassesValidator GUI, the easiest way to acquire glassesValidator is to [download
-a standalone executable](https://github.com/dcnieho/glassesValidator/releases/latest).
-
-For users who wish to use glassesValidator in their Python code, ~~the package can be installed directly from Python using the command
-`python -m pip install glassesValidator`. Should that fail,~~ this repository is pip-installable as well:
+The easiest way to acquire glassesValidator is to install it directly from Python using the command
+`python -m pip install glassesValidator`. Should that fail, this repository is pip-installable as well:
 `python -m pip install git+https://github.com/dcnieho/glassesValidator.git#egg=glassesValidator`. NB: on some platforms you may have
 to replace `python` with `python3` in the above command lines.
 
 Once pip-installed in your Python distribution, running the GUI on any of the supported operating systems requires only the following two lines of code:
 ```python
 import glassesValidator
 glassesValidator.GUI.run()
-````
+```
 
 # Usage
 The glassesValidator validation procedure consists of two parts, 1) a poster that is used during a recording, and 2) Python software

README.md

@@ -60,15 +60,17 @@ def get_zip_include_files():
         "optimize": 1,
         "packages": [
             'numpy','matplotlib','scipy','pandas','glassesValidator','OpenGL','cv2',
-            'ffpyplayer.player','ffpyplayer.threading'      # some specific subpackages that need to be mentioned to be picked up correctly
+            'ffpyplayer.player','ffpyplayer.threading',      # some specific subpackages that need to be mentioned to be picked up correctly
+            'imgui_bundle._imgui_bundle'
         ],
         "excludes":["tkinter"],
         "zip_includes": get_zip_include_files(),
         "zip_include_packages": "*",
         "zip_exclude_packages": [
             "OpenGL_accelerate",
             "glfw",
-            "cv2"
+            "cv2",
+            "imgui_bundle"
         ],
         "silent_level": 1,
         "include_msvcr": True

buildGUI.py

@@ -11,7 +11,7 @@
     <OutputPath>.</OutputPath>
     <ProjectTypeGuids>{888888a0-9f3d-457c-b088-3a5042f75d52}</ProjectTypeGuids>
     <LaunchProvider>Standard Python launcher</LaunchProvider>
-    <InterpreterId>MSBuild|venv|$(MSBuildProjectFullPath)</InterpreterId>
+    <InterpreterId>MSBuild|.venv|$(MSBuildProjectFullPath)</InterpreterId>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)' == 'Debug'" />
   <PropertyGroup Condition="'$(Configuration)' == 'Release'" />
@@ -108,15 +108,15 @@
     <Folder Include="utils\cameraCalibration\" />
   </ItemGroup>
   <ItemGroup>
-    <Interpreter Include="venv\">
-      <Id>venv</Id>
+    <Interpreter Include=".venv\">
+      <Id>.venv</Id>
       <Version>3.10</Version>
-      <Description>venv (Python 3.10 (64-bit))</Description>
+      <Description>.venv (Python 3.10 (64-bit))</Description>
       <InterpreterPath>Scripts\python.exe</InterpreterPath>
       <WindowsInterpreterPath>Scripts\pythonw.exe</WindowsInterpreterPath>
       <PathEnvironmentVariable>PYTHONPATH</PathEnvironmentVariable>
       <Architecture>X64</Architecture>
     </Interpreter>
   </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Python Tools\Microsoft.PythonTools.targets" />
-</Project>
+</Project>