Adding delay slider to QR and other small changes

.ci/create-spec.py

@@ -0,0 +1,129 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2021-2024 Krux contributors
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+build.py
+"""
+from re import findall
+from os import listdir
+from os.path import join, isfile
+from pathlib import Path
+from platform import system
+import argparse
+import PyInstaller.building.makespec
+
+import sys
+sys.path.append(".")
+from seedqreader import VERSION
+
+if __name__ == "__main__":
+    p = argparse.ArgumentParser()
+    PyInstaller.building.makespec.__add_options(p)
+    PyInstaller.log.__add_options(p)
+
+    SYSTEM = system()
+
+    # build executable for following systems
+    if SYSTEM not in ("Linux", "Windows", "Darwin"):
+        raise OSError(f"OS '{system()}' not implemented")
+
+    # Get root path to properly setup
+    DIR = Path(__file__).parents
+    ROOT_PATH = Path(__file__).parent.parent.absolute()
+    PYNAME = "seedqreader"
+    PYFILE = f"{PYNAME}.py"
+    KFILE = str(ROOT_PATH / PYFILE)
+    ASSETS = str(ROOT_PATH / "assets")
+    ICON = join(ASSETS, "icon.png")
+    # I18NS = str(ROOT_PATH / "src" / "i18n")
+
+    BUILDER_ARGS = [ ]
+
+    # The app name
+    BUILDER_ARGS.append(f"--name={PYNAME}_{VERSION}")
+
+    # The application has window
+    BUILDER_ARGS.append("--windowed")
+
+    # Icon
+    BUILDER_ARGS.append(f"--icon={ICON}")
+
+    # Specifics about operational system
+    # on how will behave as file or bundled app
+    if SYSTEM == "Linux":
+        # Tha application is a GUI
+        BUILDER_ARGS.append("--onefile")
+
+    elif SYSTEM == "Windows":
+        # Tha application is a GUI with a hidden console
+        # to keep `sys` module enabled (necessary for Kboot)
+        BUILDER_ARGS.append("--onefile")
+        BUILDER_ARGS.append("--console")
+        BUILDER_ARGS.append("--hidden-import=win32timezone")
+        BUILDER_ARGS.append("--hide-console=minimize-early")
+        BUILDER_ARGS.append("--add-binary=assets/libiconv.dll:.")
+        BUILDER_ARGS.append("--add-binary=assets/libzbar-64.dll:.")
+
+    elif SYSTEM == "Darwin":
+        # Tha application is a GUI in a bundled .app
+        BUILDER_ARGS.append("--onefile")
+        BUILDER_ARGS.append("--noconsole")
+
+        # For darwin system, will be necessary
+        # to add a hidden import for ssl
+        # (necessary for request module)
+        BUILDER_ARGS.append("--hidden-import=ssl")
+        BUILDER_ARGS.append("--hidden-import=pillow")
+        BUILDER_ARGS.append("--optimize=2")
+
+    # Necessary for get version and
+    # another infos in application
+    # BUILDER_ARGS.append("--add-data=pyproject.toml:.")
+    BUILDER_ARGS.append("--add-data=form.ui:.")
+
+    # some assets 
+    for f in listdir(ASSETS):
+        asset = join(ASSETS, f)
+        if isfile(asset):
+            if asset.endswith("png") or asset.endswith("gif") or asset.endswith("ttf"):
+                BUILDER_ARGS.append(f"--add-data={asset}:assets")                
+
+    # Add i18n translations
+    # for f in listdir(I18NS):
+    #     i18n_abs = join(I18NS, f)
+    #     i18n_rel = join("src", "i18n")
+    #     if isfile(i18n_abs):
+    #         if findall(r"^[a-z]+\_[A-Z]+\.UTF-8\.json$", f):
+    #             BUILDER_ARGS.append(f"--add-data={i18n_abs}:{i18n_rel}")
+
+
+    args = p.parse_args(BUILDER_ARGS)
+
+    # Now generate spec
+    print("============================")
+    print("create-spec.py")
+    print("============================")
+    print()
+    for k, v in vars(args).items():
+        print(f"{k}: {v}")
+
+    print()
+    PyInstaller.building.makespec.main([PYFILE], **vars(args))

.gitignore

@@ -2,3 +2,9 @@
 __pycache__/
 venv/
 config
+.seedqrenv/
+.venv/
+.env/
+build/
+*.spec
+dist/

README.md

@@ -1,34 +1,83 @@
-SeedQReader
----
+# SeedQReader
 
-SeedQReader is a simple tool made for communicate with airgapped Bitcoin Signer.
+<img src="assets/icon.png" width="64"/>
+
+**SeedQReader** is a simple tool made for communicate with airgapped Bitcoin Signer.
 
 ![SeedQReader](screenshot.png)
 
 It actually can send/receive:
 - 1 Frame QRCodes
-- Multiframes QRCodes using the `Specter` format (_of_)
+- Multiframes QRCodes using the `Specter` format (_p M of N_)
 - Multiframes QRCodes using the `UR` format are partially supported (PSBT and Bytes)
+- Multiframes QRCodes using the `BBQR` format are partially supported (PSBT)
+
+## Download the latest releases
+[<img src="assets/badge_github.png" alt="github releases page" width="186">](https://github.com/tadeubas/seedQReader/releases)
 
-Dependencies:
-opencv might be installed
+## Install
 
-Install:
-Go into this repo and run:
+To install on **Linux**, enter the repo folder and run:
 ```
+# create environment to install dependencies
+python3 -m venv .seedqrenv
+
+# activate the environment on the current terminal
+source .seedqrenv/bin/activate
+
+# install python dependencies on this environment
 pip install -r requirements.txt 
 ```
 
-Run under Linux/MacOS:
+If you get this error on **Linux**, please install libxcb-cursor:
+```
+# qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin.
+sudo apt install libxcb-cursor0
+```
+
+To install on **Windows**:
+```
+# create environment to install dependencies
+python -m venv .seedqrenv
+
+# activate the environment on the current cmd
+.seedqrenv\Scripts\activate
+
+# install python dependencies on this environment
+pip install -r requirements.txt
+```
+
+If you get this error on **Windows**, install `vcredist_x64.exe` [Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-US/download/details.aspx?id=40784). Then uninstall and install `pyzbar` lib again:
+```
+FileNotFoundError: Could not find module 'libiconv.dll' (or one of its dependencies). Try using the full path with constructor syntax.
+pyimod03_ctypes.install.<locals>.PyInstallerImportError: Failed to load dynlib/dll 'libiconv.dll'. Most likely this dynlib/dll was not found when the application was frozen.
+[PYI-5780:ERROR] Failed to execute script 'seedqreader' due to unhandled exception!
+```
+
+## Run
+
+**Linux/MacOS**:
 ```
-python3 seedqreader.py
+./.seedqrenv/bin/python3 seedqreader.py
 ```
 
-Run under Windows:
+**Windows**:
 ```
 python seedqreader.py
 ```
 
-If you want i build more cool tools you can support me with bitcoin:
-`bc1q5pgfrt09f4vuxyryg95erge38nw94usvpe5gg0`
 
+## Build binaries
+
+```
+pip install PyInstaller
+rm seedqreader_*.spec
+python3 .ci/create-spec.py
+python3 -m PyInstaller seedqreader_*.spec
+```
+
+## Acknowledgements & Alternatives
+
+Big thanks to [pythcoiner](https://github.com/pythcoiner) for originally creating SeedQReader! 🙌
+
+If SeedQReader isn’t your vibe, check out [bitcoin-qr-tools](https://github.com/andreasgriffin/bitcoin-qr-tools) for another awesome QR code tool for BTC stuff. 😄