pc-cleaner 1.0.0__tar.gz

pc_cleaner-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rituraj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pc_cleaner-1.0.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: pc-cleaner
+Version: 1.0.0
+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
+```
+
+## Use
+
+Launch the terminal dashboard:
+
+```bash
+pc-cleaner
+```
+
+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
+```
+
+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
+
+## 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

pc_cleaner-1.0.0/README.md

@@ -0,0 +1,52 @@
+# 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
+```
+
+## Use
+
+Launch the terminal dashboard:
+
+```bash
+pc-cleaner
+```
+
+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
+```
+
+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
+
+## 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

pc_cleaner-1.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pc-cleaner"
+version = "1.0.0"
+description = "Safe disk analytics, duplicate discovery, and offline reports"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{name = "Rituraj"}]
+keywords = ["disk", "storage", "analytics", "duplicate-files", "cleanup", "tui"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: End Users/Desktop",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: System :: Filesystems",
+]
+dependencies = ["textual>=0.80,<2"]
+
+[project.scripts]
+pc-cleaner = "pc_cleaner.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/rituraj/pc-cleaner"
+Issues = "https://github.com/rituraj/pc-cleaner/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

pc_cleaner-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pc_cleaner-1.0.0/src/pc_cleaner/__init__.py

@@ -0,0 +1,5 @@
+"""PC Cleaner — safe disk analysis, duplicate discovery, and reports."""
+
+from .core import VERSION
+
+__version__ = VERSION

pc_cleaner-1.0.0/src/pc_cleaner/cli.py

@@ -0,0 +1,64 @@
+"""Public command line entry point for :mod:`pc_cleaner`."""
+
+from __future__ import annotations
+
+import sys
+
+from . import __version__
+from . import core
+
+
+USAGE = """PC Cleaner - safe disk analyzer and cleanup advisor
+
+Usage:
+  pc-cleaner                         Open the interactive terminal UI
+  pc-cleaner tui                     Open the interactive terminal UI
+  pc-cleaner scan [SCAN OPTIONS]     Run a scan and write reports
+  pc-cleaner report --from-db DB     Regenerate reports from a saved scan DB
+
+Examples:
+  pc-cleaner
+  pc-cleaner scan --drive D --open
+  pc-cleaner scan --path "D:\\Projects" --no-dups
+  pc-cleaner report --from-db .scan_tmp_20261008_055421.db
+
+Safety: PC Cleaner is read-only. It finds reclaimable data but never deletes it.
+"""
+
+
+def _scan_help() -> int:
+    core.build_argparser().print_help()
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    args = list(sys.argv[1:] if argv is None else argv)
+    if not args or args[0] in {"tui", "ui"}:
+        from .tui import run_tui
+        return run_tui(args[1:])
+    if args[0] in {"-h", "--help", "help"}:
+        print(USAGE)
+        return 0
+    if args[0] in {"-V", "--version"}:
+        print("pc-cleaner %s" % __version__)
+        return 0
+    if args[0] == "scan":
+        if len(args) > 1 and args[1] in {"-h", "--help"}:
+            return _scan_help()
+        return core.main(args[1:])
+    if args[0] == "report":
+        if len(args) > 1 and args[1] in {"-h", "--help"}:
+            return _scan_help()
+        return core.main(args[1:])
+
+    # Preserve convenience for existing users: `pc-cleaner --drive D` works.
+    if args[0].startswith("-"):
+        return core.main(args)
+
+    print("Unknown command: %s\n" % args[0], file=sys.stderr)
+    print(USAGE, file=sys.stderr)
+    return 2
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())