CleanCrow

Complete Documentation for the Windows Cleaning and Optimization Tool

๐Ÿ“‹ Overview

CleanCrow is a desktop application developed in Python with a PyQt5 interface, designed to automate maintenance, cleaning, and updating tasks for Windows systems. It uses native operating system tools to ensure security and compatibility.

"Keep your Windows clean, fast, and up to date with just one click."

โœจ Features

๐Ÿ—๏ธ Architecture

The project is organized into well-defined layers:

Note: The project follows a layered architecture pattern, making it easy to maintain and add new features.

๐Ÿงน Available Cleaners

Below are all cleaning modules available in CleanCrow:

Cleaner Description Requires Admin Risk Level
TempCleanerUser temporary filesNoSafe
WindowsTempCleanerWindows temporary filesYesSafe
RecycleBinCleanerEmpties the Recycle BinNoSafe
ThumbnailCleanerThumbnail cacheNoSafe
WERCleanerError reportsNoSafe
WindowsUpdateCleanerWindows Update cacheYesAdvanced
BrowsersCleanerBrowser cacheNoSafe
WebCacheCleanerWeb application cacheNoSpecial
NvidiaCacheCleanerNVIDIA shader cacheNoAdvanced
AmdCacheCleanerAMD shader cacheNoAdvanced
SystemCleanerAdvanced cleaning (cleanmgr + DISM)YesAdvanced
DNSCleanerDNS cacheYesSafe
ComponentStoreCleanerComponent Store (DISM)YesAdvanced

Warning: Some cleaners require administrator privileges and may close running applications (e.g., browsers).

๐Ÿ”’ Security

๐Ÿ“Š Logs

The logging system records operations with the following levels:

Level Description
infoGeneral information
successSuccessful operation
warningWarnings
errorErrors
stepCleaning steps
systemSystem messages
detailTechnical details

๐Ÿš€ How to Run

Prerequisites

Installing Dependencies

pip install PyQt5 qtawesome

Running the Application

python main.py

The application will automatically request administrator privileges when necessary.

๐Ÿ—๏ธ Building the Executable

To generate the executable, use:

pip install pyinstaller
pyinstaller CLEANCROW.spec

The executable will be generated at dist/CLEANCROW.exe.

โš ๏ธ Known Limitations

๐Ÿ“„ License

Distributed under the GNU GPL v3.0 license. See the LICENSE file for more details.