Metadata-Version: 2.4
Name: pc-cleaner
Version: 1.4.1
Summary: Safe disk analytics, duplicate discovery, and offline reports
Author: Rituraj
License-Expression: MIT
Project-URL: Homepage, https://github.com/rituraj/pc-cleaner
Project-URL: Issues, https://github.com/rituraj/pc-cleaner/issues
Keywords: disk,storage,analytics,duplicate-files,cleanup,tui
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: System :: Filesystems
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual<2,>=0.80
Dynamic: license-file

# PC Cleaner

**PC Cleaner** is a safe, cross-platform disk analytics tool. It scans a drive or
folder and produces an offline HTML dashboard, JSON data, and a complete CSV
file inventory. It finds duplicate files and cleanup candidates, but it never
deletes or changes user files.

## Install

```bash
pip install pc-cleaner
```

PC Cleaner works on Windows, macOS, Linux desktops, WSL, and Linux VPS hosts.
On Windows it lists drive letters; on POSIX systems it lists useful mounted
filesystems while avoiding virtual kernel mounts such as `/proc`, `/sys`, and
`tmpfs`.

## Use

Launch the terminal dashboard:

```bash
pc-cleaner
```

The dashboard lists accessible drives with free-space information and includes
a folder browser. Select a drive, click a folder to make it the scan target,
or type a path manually. While scanning it shows the subprocess output, offers
a visible cancel button, and keeps the scan controls disabled until completion.

During scans, the dashboard shows the active phase, elapsed time, indexed file
and folder totals, data indexed, and files-per-second rate. Filesystem discovery
does not pretend to know an exact completion time; it displays an honest unknown
ETA until traversal is complete. Duplicate hashing has a known candidate count,
so it shows a real remaining-time estimate. When an HTML report completes, use
**Open HTML report** to open it directly in the default browser.

Check for an update from PyPI:

```bash
pc-cleaner update
```

This asks before installing. After a successful upgrade, restart PC Cleaner to
use the new release. For non-interactive automation only, use:

```bash
pc-cleaner update --yes
```

Run from scripts or CI:

```bash
pc-cleaner scan --drive D --open
pc-cleaner scan --path "D:\\Projects" --no-dups
pc-cleaner scan --path ~/Downloads --out ./reports
pc-cleaner scan --path /var --out ~/pc-cleaner-reports --no-dups --verbose
```

For an Ubuntu/Linux VPS over SSH, use command mode explicitly. If the terminal
is not interactive, `pc-cleaner` will show the equivalent CLI command instead
of trying to open a full-screen terminal interface.

The scan produces timestamped HTML, JSON, and CSV reports. The default report
location is your current directory; use `--out REPORTS_DIR` to choose another.

## Features

- Fast, recursive, read-only scans using `os.scandir`
- Self-contained offline HTML dashboard with sortable tables
- Full CSV file inventory and machine-readable JSON summary
- Largest files, folders, extensions, categories, ages, and size buckets
- Duplicate finder using BLAKE2b hashes after efficient size grouping
- Junk/cache/zero-byte/empty-folder signals
- Access-error handling and Windows long-path support
- SQLite-backed processing for very large drives
- Drive chooser and browsable folder tree in the terminal dashboard
- Confirmed PyPI update checker; no automatic restart or silent upgrade
- Cross-platform mount discovery and VPS-safe virtual filesystem exclusions

## Safety

PC Cleaner is an **analysis and recommendation** tool. It does not delete,
move, modify, or upload your data. Review report findings yourself before
performing any cleanup.

## License

MIT
