Metadata-Version: 2.4
Name: easyupdate
Version: 1.0.1
Summary: A lightweight Python module to automatically update your script when a new version is released. Allows compilation to `.exe` and Linux executables.
Author: GeekMan44
License: MIT License
        
        Copyright (c) 2025 GeekMan44
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/GeekMan44/EasyUpdate
Project-URL: Discord, https://discord.gg/Exyfg8aD3Y
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: psutil
Dynamic: license-file

# 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

```bash
pip install easyupdate
```
### 2. Import the module in your project

```py
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)

```json
{
    "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
