sticker-convert

Running python script directly

1. Install python3

Install python3 from https://www.python.org/

2. Install python modules

Install the required python modules with pip3 install -r requirements.txt

3. Running the script

Change directory into sticker_convert directory and run python3 ./sticker-convert.py

Compiling on Windows and MacOS

This repository uses nuitka (factory branch) for compiling. Just run python compile.py, compilation result in sticker-convert.dist directory.

Creating AppImage on Linux

  1. Use Ubuntu 20.04 (May work on newer version if you change sourceline in AppImageBuilder.yml)
  2. Install appimage-builder
    wget -O appimage-builder-x86_64.AppImage https://github.com/AppImageCrafters/appimage-builder/releases/download/v1.1.0/appimage-builder-1.1.0-x86_64.AppImage
    chmod +x appimage-builder-x86_64.AppImage
    sudo mv appimage-builder-x86_64.AppImage /usr/local/bin/appimage-builder
    
  3. Clone this repository
  4. Run appimage-builder --recipe ./AppImageBuilder-x86_64.yml
  5. If successful, sticker-convert-x86_64.AppImage should be created

Create msi installer

  1. Install .NET SDK
  2. Install Wix: dotnet tool install --global wix --version 4.0.4
  3. Install WixUI dialog library: wix extension add WixToolset.UI.wixext/4.0.4
  4. python compile.py
  5. mv sticker-convert.dist sticker-convert
  6. python msicreator\createmsi.py msicreator.json

Build wheel

  1. To build wheel pip -m build .
  2. To install wheel pip install dist/sticker_convert-xxx.whl

Development

Install development requirements first:

pip install -r requirements-dev.txt

To run tests:

pytest

To run linter:

mypy
pyright
ruff check
ruff format
isort .