Skip to content

GeekMan44/EasyUpdate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

EasyUpdate

🛠️ A lightweight Python module to automatically update your script when a new version is released. Allows compilation to .exe and Linux executables.

📦 Features

  • Checks if an update is available using a JSON file hosted on GitHub
  • Downloads files when an update is available
  • Can update itself and wait for the main script to stop before updating files
  • Cross-platform support
  • Supports .exe and Linux compiled files
  • Custom error messages to help identify failures
  • Active support via Discord

🚀 Usage

1. Install the module with pip

pip install easyupdate

2. Import the module in your project

from easyupdate import UpdateManager

version = "1.2.0"
EasyUpdate = UpdateManager(
    version_file=version,
    version_url="https://url_to_versions_file/",
    updater_name="update.exe" # Name of the updater if compiled in .exe or linux executable
)

EasyUpdate.search_update()
EasyUpdate.download_update(True)

3. Make versions file

  • Use our tool to generate the file for you (soon)
{
    "latest": {
        "version": "1.3.4",
        "endpoint": "https://raw.githubusercontent.com/GeekMan44/EasyUpdate/refs/heads/main/",
        "files": [
            {
                "file": "LICENSE",
                "folder": ""
            },
            {
                "file": "versions",
                "folder": "version"
            }
        ]
    }
}

🕒 Soon

  • Tool to generate file versions
  • Make a web documentation

About

A lightweight Python module that adds automatic update functionality to your scripts via GitHub.

Resources

License

Stars

4 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages