---

⚠️ Attention

• This project is in a beta phase due to limited testing at this time.. Although primarily developed for learning purposes, it effectively addresses my specific needs.
• Important: Follow the instructions in the Releases section when updating the script. Updates may include new features or changes that could require different steps. I’ll strive to keep the instructions as simple as possible.
• Currently supported: Linux only. While it might work on macOS, it has not been tested yet.

---

🦄 About my-unicorn

• I created this project to solve my problem. This script installs an AppImage from the GitHub API, saves it to a user-selected directory, creates a config file (JSON) to save information about the AppImage and automate the update process. Also, this script is able to verify whether the AppImage has been installed correctly from GitHub by checking the SHA256 or SHA512 hash of the verification file from the GitHub repository against the actual AppImage.

• Applications tested with this script:

  • 🛠️ Tested:
    • super-productivity
    • siyuan-note
    • Joplin

• 🛠️ Tested:

  • sha256
  • sha512

---

💡 How to Use

Install:

1. Open a terminal and clone this repo (make sure you have git installed):

   cd ~/Downloads &
   git clone https://github.com/Cyber-Syntax/my-unicorn.git

2. Navigate to the project directory:

   cd ~/Downloads/Cyber-Syntax/my-unicorn

3. Optional: Create a virtual environment (Recommended)

   • Create a virtual environment:
     • python3 -m venv .venv
   • Activate the virtual environment:
     • source .venv/bin/activate
   • Install dependencies using pip:
     • pip install -r requirements.txt
   • If this doesn't work, install manually (some of them may already be installed; exclude those if you encounter an error again).
     • pip3 install babel certifi idna charset-normalizer PyYAML requests tqdm urllib3

4. Activate the virtual environment (if applicable):

   source .venv/bin/activate

5. Continue reading below to learn how to use.

---

Using app:

1. You can copy super-productivity.json or other example config files from the config_files_examples/ folder to your appimage folder path (default: ~/Documents/appimages/config_files/super-productivity.json). This config file is an example for super-productivity appimage.

2. Using the app to create one for you, but you'll need to know some information about the application:

   • GitHub URL: The repository URL of the app (e.g., https://github.com/johannesjo/super-productivity).
   • Hash type: Specify the hash type (e.g., sha512 for super-productivity).
   • Hash verification issues: If the hash verification fails, you can manually add the hash to the JSON file:
     • Look for the latest hash in the GitHub release page (e.g., super-productivity releases).
     • Check the json_files folder for examples. All JSON files should work as expected.

📥 How to Install a New AppImage (Create Config File)

╰─❯ python3 main.py
Welcome to my-unicorn 🦄!
Choose one of the following options:
===================================
1. Update existing AppImage
2. Download new AppImage
3. Update json file
4. Exit
===================================
Enter your choice: 2
Downloading new AppImage
Choose one of the following options:
===================================
1. Backup old AppImage and download new AppImage
2. Download new AppImage and overwrite old AppImage
Enter your choice: 1
===================================
Enter the app GitHub URL: https://github.com/laurent22/joplin
Which directory to save the AppImage (Default: '~/Documents/appimages'):
Which directory to save the old AppImage (Default: '~/Documents/appimages/backup'):
Enter the hash type for your sha (sha256, sha512): sha512
===================================
Parsing the owner and repo from the URL...
Joplin downloading... Grab a cup of coffee :) This may take a while depending on your internet speed.
Joplin-2.13.12.AppImage: 100%|██████████████████████████████████████████████████| 201M/201M [00:19<00:00, 11.0MiB/s]

---

🔄 1. How to Update AppImage

╰─❯ python3 main.py

Welcome to my-unicorn 🦄!
Choose one of the following options:
====================================
1. Update existing AppImage
2. Download new AppImage
3. Update json file
4. Exit
====================================
Enter your choice: 1

There are more than one .json file, please choose one of them:
============================================================
1. siyuan.json
2. super-productivity.json
3. joplin.json
============================================================
Enter your choice: 3

---

🙏 Support This Project

• Consider giving it a star ⭐ on GitHub to show your support and keep me motivated on my coding journey!
• 💖 Sponsor me: If you'd like to support my work and help me continue learning and building projects, consider sponsoring me:
  • 

🤝 Contributing

• This project is primarily a learning resource for me, but I appreciate any feedback or suggestions! While I can't promise to incorporate all contributions or maintain active involvement, I’m open to improvements and ideas that align with the project’s goals.
• Anyway, please refer to the CONTRIBUTING.md file for more detailed explanation.

---

📝 License

This script is licensed under the [GPL 3.0 License]. You can find a copy of the license in the LICENSE file or at www.gnu.org.

---