Skip to content

README.md

Latest commit

 

History

History
91 lines (75 loc) · 3.54 KB

README.md

File metadata and controls

91 lines (75 loc) · 3.54 KB

Python License Linux GitHub release

AutoAppImage

AutoAppImage is a helper for building ELF binaries and turning them into .AppImage with extreme ease!
This application uses the following libraries: CustomTkinter, CTkMessagebox, subprocess, threading, shutil, platform os and sys.
The available binaries were compiled with Nuitka.

Table of Contents

Preview

Main interface

Current Features

  • Simple GUI
  • Error handling with message boxes
  • Project ELF binary compilation
  • Final AppImage executable creation based on ELF binary

Requirements

If you're going to use the source code version, you must install the latest Python version. 🐍
Otherwise, you will not need to download anything, as AutoAppImage downloads and handles the dependencies.

How to Use

  1. Download the latest release of this project;
  2. [IMPORTANT] Give the .AppImage executable/write permissions with chmod +xw and open it;
  3. Fill the required fields;
  4. Click "Build AppImage;"
  5. Wait for the process to end and enjoy the .AppImage!

Tip

The third field, "Enter your project's imports", refers to the --enable-plugin flag. For more information, check this page.
The fourth field, "Include optional package data", refers to --include-package-data. This field is reserved for automatically detecting your dependency files.
The last field, "Include package data path", refers to --include-data-dir/--include-data-file, which is a manual version of the fourth field.

Using the Source Code

  1. Clone the repository:

    git clone https://github.com/Guilherme-A-Garcia/AutoAppImage.git
cd Easy-DLP

  2. Create and activate a virtual environment (recommended):

    python3 -m venv venv
source venv/bin/activate

  3. Install the required packages using the requirements.txt file:

    pip install -r requirements.txt

  4. Run main.py within the project's directory:

    python main.py

Acknowledgements

This project depends on two extremely reliable and important third-party tools:

  • Nuitka, which builds the base ELF for the user's projects;
  • AppImageTool, which then turn the previous binary into a portable .AppImage for extra compatibility.

How to Contribute

✨ Contributions are always welcome! ✨

  • Report Bugs: Open an issue with detailed steps to reproduce.
  • Suggest Features: Open an issue to discuss your idea.
  • Contribute Directly to the Code:
    I. Fork the repository;
    II. Create a new branch;
    III. Make your changes and commit;
    IV. Push to the branch;
    V. Open a Pull Request;
    VI. Kindly wait for approval. ;)

Thank you for reading!