Skip to main content

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

Project description

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
)

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
  • Upload module on PyPi
  • Make a web documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easyupdate-1.0.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

easyupdate-1.0.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file easyupdate-1.0.1.tar.gz.

File metadata

  • Download URL: easyupdate-1.0.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.0

File hashes

Hashes for easyupdate-1.0.1.tar.gz
Algorithm Hash digest
SHA256 02079ddee1414bc55dde2d6c4feb43a521995fabfbdee4c6a031ea4c6b1b761e
MD5 00224563f598022448f850405d9eb429
BLAKE2b-256 07592e45af2606cd99e7a98eb89a2981772b8ff098787a09a82664c5b29f6595

See more details on using hashes here.

File details

Details for the file easyupdate-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: easyupdate-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.0

File hashes

Hashes for easyupdate-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d41b290af0088565fd73deacc9c18a6cf36dfb309d2c9b149ecb071c1807af3
MD5 dc0defe3b794a6fa8a0ed380e58fae82
BLAKE2b-256 7b1688fb8f220b22371d79ce83d60df9582c60c07ec46c56881e9275faba1666

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page