https://github.com/yuzu02/yuu-tools
CLI APP to manage and run scripts automated
https://github.com/yuzu02/yuu-tools
cli-app python-script typer-cli useful-scripts
Last synced: 2 months ago
JSON representation
CLI APP to manage and run scripts automated
- Host: GitHub
- URL: https://github.com/yuzu02/yuu-tools
- Owner: Yuzu02
- License: mit
- Created: 2024-06-19T21:27:22.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-07-27T01:10:56.000Z (10 months ago)
- Last Synced: 2025-01-31T22:47:24.747Z (4 months ago)
- Topics: cli-app, python-script, typer-cli, useful-scripts
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yuu Tools - CLI APP to manage and run scripts
Yuu Tools is a CLI application that allows you to manage and run scripts in a simple and organized way using menus on the command line.
## Features
- Manage the config file from the CLI app
- Run scripts in a simple and organized way
- Focusing on the user experience on the command line
- Easy to use and configure
- Log system to track the execution of the scripts
- More Features coming soon
## Roadmap
- Add more scripts
- Refactor CLI Menus to handle more scripts
- Refactor Config File to handle new scripts
- Translate the CLI app to English
- Log system to track the execution of the scripts
## Script -> Sort Files
## Features of the script
- Recursively explore a root folder and its subfolders to find files to organize.
- Move files to corresponding folders based on defined extensions and categories.
- Ignore files and folders marked as exceptions.
- Delete empty folders after organization.
- Easy configuration of paths, extensions, and exceptions through a JSON file managed by the CLI app.
## Script Roadmap
- Add more file/folder operations like copy, move, rename
- Support additional file attributes to organize (size, date etc)
## Installation
```bash
git clone https://github.com/Yuzu02/Yuu-Tools.git
cd Yuu-Tools
pip install -r requirements.txt
```
## Usage
```bash
python yuu_tools.py
```
## Setup
- The first time you run the application, it will ask you to create a configuration file.
- The configuration file will be created in the same directory as the application.
- The configuration file will be named `config.json`.
- The configuration file will be used to store the info needed to run the scripts.
- The configuration file will have the a base structure to modify at your convenience by the CLI app.
- Now you can manage and run scripts from the CLI app.
## Contributing
This project is open to contributions, suggestions, and improvements. Feel free to contribute to this project by creating a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.