pyproject-appimage

pyproject-appimage allows you to create a AppImage in a few seconds. To get started, just add this to your pyproject.toml:

[tool.pyproject-appimage]
script = "my-app"
output = "MyApp.AppImage"

script is here the script that should be run when executing the AppImage. You can use the project.scripts section of your pyproject.toml or the entry_points argument of your setup.py to create scripts.

To create a AppImage, just run this command in your project directory:

pyproject-appimage

Pyproject options

The following options can be used in your pyproject.toml:

Note: All paths are relativ to your project directory

Cli options

pyproject-appimage provides the following cli options:

usage: pyproject-appimage [-h] [--output OUTPUT] [--project-dir PROJECT_DIR] [--python-version PYTHON_VERSION] [--appimagekit-url APPIMAGEKIT_URL] [--work-dir WORK_DIR]
                          [--list-available-versions] [--no-fuse] [-v]

options:
  -h, --help            show this help message and exit
  --output OUTPUT       Sets the putput filename
  --project-dir PROJECT_DIR
                        Sets the project dir
  --python-version PYTHON_VERSION
                        Set a custom Python version
  --appimagekit-url APPIMAGEKIT_URL
                        Set a custom download URL for AppImageKit
  --work-dir WORK_DIR   Set a custom directory to work in. Existing Directories will be removed.
  --list-available-versions
                        Print available Python versions and exit
  --no-fuse             Use this, if FUSE is not available e.g. inside a Docker container
  -v, --version         Prints the version and exit

Projects using pyproject-appimage

• jdMinecraftLauncher
• jdNBTExplorer
• jdReplace
• jdMrpackInstaller
• jdDesktopEntryEdit
• jdAppStreamEdit

pyproject-appimage is of course also available as AppImage

pyproject-appimage is based on the work of niess