Kush’s Utils Tool
Kush’s Utils Tool is my personal collection of scripts which is used to automated daily tasks. It is a evergrowing collection of scripts and will continue to evolve till the day I program. This is also my first python project.
Ever evolving project. May see major rework at at anypoint of time
Current version – 0.0.1
Features
- Project Structure creator for a given language (currently cpp only)
- More scripts will be added soon and the tool will be extended as and when need be…
Usage
kush-util.pyis the entry point. Other files are helpers.
First Level Arguments
Usage : python kush-util.py <command> [opt-args]
| CLI Arguments | Type | Description |
|---|---|---|
| -h, –help | opt-args | Show help for commands |
| -v, –version | opt-args | Show version for the utils program |
| create | pos-args | Create project from templates |
| modify | pos-args | Modify project templates metadata |
| delete | pos-args | Delete project folder created using utils |
For Creating a Project – Second Level Arguments
Usage : python kush-util.py create [opt-args]
| CLI Arguments | Type | Description |
|---|---|---|
| -h, –help | opt-args | Show help for create |
| –plang | opt-args | Specify Projects Programming Language |
| –pname | opt-args | Specify Projects Name |
| –pname | opt-args | Specify Projects Path |
Running
- Create a virtualenv
- Get the required packages through pip from requirements.txt
- Run the
kush-util.pyscript with the required args.
Requirements
- pathlib –
Approach for pathlib usage:- create directory if not exist
- create file if not exist and populate specific filetype with predefined templates
- basically filesystem related tasks.
- anytree –
Approach for anytree usage:- store project and directory structure as tree
- check if leaf is file then create the file with a predefined template
- if the leaf is a directory keep the directory empty
- argparse –
Approach for argparse usage:- multiple sub-parser for major commands
- args in the sub-parsers for major commands specific feature
- inspiration for chained arguments taken from git cli.
Contributing
NOTE: Check the TODO before opening issues to check if it is detected and is being worked upon.
This project is open to and encourages contributions! Feel free to discuss any bug fixes/features in the issues. If you wish to work on this project and extend it with your own daily usage scripts:
- Fork this project
- Create a branch (
git checkout -b new-branch) - Commit your changes (
git commit -am 'add new feature') - Push to the branch (
git push origin new-branch) - Submit a pull request!
