Metadata-Version: 2.1
Name: AsthoUpdater
Version: 0.2.1
Summary: A useless asynchronous lib to update files.
Home-page: https://github.com/Asthowen/AsthoUpdater
Author: Asthowen
License: UNKNOWN
Description: # AsthoUpdater
        [![forthebadge made-with-python](https://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/) [![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://github.com/)
        
        AsthoUpdater is a useless asynchronous lib to update files.
        
        ## Made with
        * [**aiohttp**](https://pypi.org/project/aiohttp/)
        * [**async-timeout**](https://pypi.org/project/async-timeout/)
        
        ## Install prerequisites
        * Execute command: ```python3 -m pip install AsthoUpdater```
        
        ## Examples
        ### Simple Update
        
        By default, the verification algorithm is sha512, you can choose another one with the `algorithm` parameter, available: sha256, sha512, crc32, md5. 
        If you want to use another one you can contact me.
        
        ```python
        from AsthoUpdater import AsthoUpdater
        
        async with AsthoUpdater("jsonUrl", "pathToUpdate") as a:
            await a.download()
        ```
        
        ### AsthoUpdater args
        ```
        json_url: Your json url, required (str)
        download_path: The download path, required (str)
        download_timeout: The timeout to download file, optionnal, 12 at default (int)
        overwrite_files: If you want re-download all files, optionnal, False at default (bool)
        file_deleter: If you want dl older files, optionnal, False at default (bool)
        logger_status: If you want enable/disable the logger, True at default (bool)
        logger_name: If you want set the logger name, AsthoUpdater at default (str)
        algorithm: If you want set the used algorithm, sha512 at default (str)
        download_limit: Limit the number of files that can be downloaded simultaneously, 10 at default (int)
        ```
        
        ### AsthoUpdater properties
        ```
        get_total_files_to_download: Return total file to download (int)
        get_total_files_downloaded: Return total files downloaded (int)
        ```
        
        ### AsthoUpdater json example
        <br>
        If you not use sha512, you must change sha512 to the one you want.
        
        ```json
        {
          "maintenance": "off",
          "files": [
              {
                "sha512": "theSha512",
                "name": "filename",
                "url": "linkOfFile",
                "path": "pathOfFile"
              },
              {
                "sha512": "theSha512",
                "name": "filename",
                "url": "linkOfFile",
                "path": "pathOfFile"
              }
          ]
        }
        ```
        
        ## Author
        [<img width="64" src="https://avatars3.githubusercontent.com/u/59535754?s=400&u=48aecdd175dd2dd8867ae063f1973b64d298220b&v=4" alt="Asthowen">](https://github.com/Asthowen)
        
        ## License
        **[AsthoUpdater](https://github.com/Asthowen/AsthoUpdater) | [Mozilla Public License 2.0](https://github.com/Asthowen/AsthoUpdater/blob/main/LICENSE)**
Platform: UNKNOWN
Requires-Python: >= 3.6
Description-Content-Type: text/markdown
