pydater 1.0.9

Basic program and file updater for Github

Pydater

When you make a program associated with Github, you can easily update with this module without the need to write an update system.

Specify the path, write a version and leave the rest to the module

Installation

Use the package manager pip to install pydater.

pip install pydater

Usage

• First of all, you should save your current version number from github.

• Create a repository for this or use an existing one.

• Create a .json file named version.json in the repo.

• Its content must be { "version" : "<version_number>"}.

• After doing this and saving, copy the raw link of the version.json file

• Come back to the relevant repo and import your most up-to-date program/application/software.

• As a last step, copy the download link of your program/application/software in the relevant repo.

Example for Update 0.1

from Pydate import pydate

path = r"C:\Users\...\MyFolder"
raw = "https://raw.githubusercontent.com/..."
pd = pydate.PyDate(path= path, raw_link= raw)

if pd.create_version_file(0.1):
    print("Update File Created")
else:
    print("Update File Already Exists")

if pd.isUpdate:
    print("Current")
else:
    print("Not Current")
    pd.downloadLink(url="<download_link_here>",extension="<'.exe' or '.pdf' or '.py' or 'bla_bla'>")
    pd.writeNewVersion()

---

Example for Update 0.2

from Pydate import pydate

path = r"C:\Users\...\MyFolder"
raw = "https://raw.githubusercontent.com/..."

pd = pydate.PyDate(path= path, raw_link= raw)

if pd.create_version_file(0.1):
    print("Update File Created")
else:
    print("Update File Already Exists")

if pd.isUpdate:
    print("Current")
else:
    print("Not Current")
    pd.downloaded_name = "program.exe"
    pd.downloadLink(url="<download_link_here>")
    pd.openNewVersion()

• Added

  • downloaded_name is added ➥ property
  • openNewVersion is added ➥ method

• Removed

  • writeNewVersion is removed ➥ method

Example For Update 1.0

import os
from Pydate import pydate

path = r"C:\Users\...\MyFolder"
raw = "https://raw.githubusercontent.com/..."

pd = pydate.PyDate(path= path, raw_link= raw)

if pd.createVersionFile(0.1):
    print("Update File Created")

else:
    print("Update File Already Exists")


if pd.isUpdate:
    print("Current")
else:
    print("Not Current")
    pd.downloaded_name = "program.exe"
    pd.downloadLink(url="<download_link_here>")
    pd.saveNewVersion(open_=False)

print(pd.readNewVersion["version"])

• Added
  • readNewVersion is added ➥ property
  • saveNewVersion is added ➥ method
• Removed
  • openNewVersion is removed ➥ method

Example For Update 1.0.5

• Ability to update scripts

from Pydate import PyDate

path = r"C:\Users\..\myfolder"
pd = Pydate(path=path,isScript=True) # if `isScript` is `False` script update cannot be used 

script_raw_link = "https://raw.githubusercontent.com/Arif-Helmsys/test/main/deneme.py" # The content in the link is an updated script 
pd.scriptUpdate(script_raw_link,myscript="myscript")

• Added
  • scriptUpdate is added ➥ method

---

About the Pydate Class

• createVersionFile (method): If the version file does not exist, it will create it. The resulting file is a json file. Returns False if the version file exists. Returns True if the version file does not exist. Takes one float argument

• get_version (property): Returns version file written on github

• isUpdate (property): Returns True if Current, False if Not Current.

• downloaded_name (property): Value by adding an extension to the end of the name. eg: pd.downloaded_name = "my_file_name.exe" or eg: pd.downloaded_name = "my_file_name.py"...https://raw.githubusercontent.com/Arif-Helmsys/test/main/deneme.py Examples can be expanded.

• readNewVersion (property): Returns the version of the locally created version file

• downloadLink (method): The argument given to the PyDate class is used as the path. Creates a folder named Installed. His argument; Download link of program/file/exe available on Github.

• saveNewVersion (method): Upgrades the version value written in the locally maintained version. json file to the version on github. Takes one parameter. Default True. If open_ parameter is True: Opens the downloaded file in the Installed folder and upgrades the version.json version. If open_ parameter is False: only upgrades the version of the script at the specified location

• scriptUpdate (method): Scripts update. Compares your main script with the current script you keep on githu If your main script is not the same as the one you keep up to date on github, it will update it.

  :param script_raw_link: eg:'https://raw.githubusercontent.com/.../../main/myScript.py'

  :param myscript: the name of my main script eg msyscript

  The method returns a bool value. If True, it is up to date. If False, it is not up-to-date. If false, change your script and write your script on github so that your relevant main script will be updated.

Author

Helmsys

License

MIT