Skip to content
/ CyClone Public

🌀 Make an Updater Script for the Python Projects

License

Notifications You must be signed in to change notification settings

lnxpy/CyClone

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CyClone 🌀




★ Make Updater Scripts for Your Python Projects ★
Build It ∘ Cross It ∘ Update It

Version Version Version

CyClone is kind of Python-Package-Updater that allows users to create an updater-version of their python project and make them available on their Github. Although users can update their local cloned repository with their own selves, getting stuck in a bunch of files and modules and trying to get out of them can be little bit noisy. First, you need to clone this repository then, start running into it and fill up your fields.



How CyClone Works?

First of all, CyClone checks up your git and tries to pull all changes from the Github server to your local environment. Then, reinstalls all new packages from the requirements file and updates importing module lists.

Setting up

After cloned the repository, install the requirements to make the main script ready to get in the work as follows.

cyclone$ pip3 install -r requirements.txt

When the installation finished up, you need to run the script and fill both SOURCE and REPOSITORY options up. Take a look at the following table to get informed about the options.

Short Form Standard Form Descryption is Essential
-r --repository repository address ✔️
-s --source library list source file (mostly requirements.txt) ✔️
Examples
python3 cyclone.py -r lnxpy/postern -s requirements.txt
python3 cyclone.py -r sys313/negar -s requires.txt

Once you fill up all the options correctly, you will have such a status:

 [CHECK] lnxpy/cyclone repository
 [CHECK] cyclone found
 [CHECK] requirements.txt source
 [CHECK] configuration started
 [CHECK] config file created

Now, It's time the check the new path disk/. Let's take a tree from this directory and see what we have. You should not modify this directory because all of them are attached to eachother.

disk
├── conf.json
├── DONT_CHANGE_THIS_DIR
├── ReadMe.txt
└── update.py

0 directories, 4 files

Time to Run up

Copy the all contents of the disk/ directory into your python local repository and push it up to the cloud side. Now make a change in your github repository and try to fetch it up in your local system using the update.py file. The configuration file should not be modified ever and also you need to be permitted as the root user to be able to update the local repository.

License

Licensed from MIT.

Fork

Fork and feed for free :)