https://github.com/lnxpy/cyclone
:cyclone: Make an Updater Script for the Python Projects
https://github.com/lnxpy/cyclone
cyclone fill github package python python-updater repository updater
Last synced: 3 months ago
JSON representation
:cyclone: Make an Updater Script for the Python Projects
- Host: GitHub
- URL: https://github.com/lnxpy/cyclone
- Owner: lnxpy
- License: mit
- Created: 2020-02-07T18:26:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T03:37:07.000Z (about 3 years ago)
- Last Synced: 2025-02-02T01:51:14.813Z (12 months ago)
- Topics: cyclone, fill, github, package, python, python-updater, repository, updater
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## CyClone :cyclone:
★ Make Updater Scripts for Your Python Projects ★
Build It ∘ Cross It ∘ Update It
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 | :heavy_check_mark: |
| `-s` | `--source` | library list source file (mostly `requirements.txt`) | :heavy_check_mark: |
| 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](https://opensource.org/licenses/MIT).
### Fork
Fork and feed for free :)