https://github.com/renan-siqueira/folder-size-scanner
A simple python tool to scan directories and log their sizes
https://github.com/renan-siqueira/folder-size-scanner
directory opensource python scanner tool
Last synced: about 1 year ago
JSON representation
A simple python tool to scan directories and log their sizes
- Host: GitHub
- URL: https://github.com/renan-siqueira/folder-size-scanner
- Owner: renan-siqueira
- License: mit
- Created: 2023-10-13T13:06:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-10T13:25:35.000Z (over 2 years ago)
- Last Synced: 2024-01-30T02:40:31.275Z (over 2 years ago)
- Topics: directory, opensource, python, scanner, tool
- Language: Python
- Homepage:
- Size: 13.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Folder Size Scanner
A python tool to scan directories and log their sizes.
This tool offers both a command-line interface and a graphical user interface.
## Project Structure
- `run.py`: The main entry point for the program. It determines whether to run in GUI or CLI mode.
- `/logs`: A directory to store log files.
- `/src`:
- `/core`: Contains the main functionality for scanning directories.
- `/gui`: Contains the graphical user interface code.
- `/modules`: Houses the various modules supporting the core functionality such as CLI prompts, formatting, logging, and scanning.
- `/settings`: Configuration and default settings for the application.
- `/utils`: Utility functions like size conversions.
- `.gitignore`: Git ignore file to exclude specific files/directories from version control.
- `LICENSE`: The license for the project.
- `README.md`: This documentation file.
- `structure.txt`: An overview of the project structure.
## Usage
1. Clone the repository.
2. Navigate to the project directory.
3. Run `run.py`.
```bash
python run.py
```
### Command-Line Interface (CLI):
4. When prompted if you want to use the graphical interface, answer 'n' for CLI mode.
5. Follow the on-screen prompts to scan directories.
### Graphical User Interface (GUI):
4. When prompted if you want to use the graphical interface, answer 'y' for GUI mode.
5. A window will appear. Use the interface to select directories and initiate scans.