devklean 1.0.0__py3-none-any.whl

devklean-1.0.0.dist-info/METADATA

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: devklean
+Version: 1.0.0
+Summary: Clean up common development artifacts (node_modules, .venv, caches) to reclaim disk space
+Project-URL: Homepage, https://github.com/smurftyy/devklean
+Project-URL: Repository, https://github.com/smurftyy/devklean
+Project-URL: Issues, https://github.com/smurftyy/devklean/issues
+Project-URL: Changelog, https://github.com/smurftyy/devklean/blob/main/CHANGELOG.md
+Author-email: smurftyy <oladapooloyede185@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cleanup,cli,development,disk-space,node_modules,venv
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Filesystems
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Requires-Dist: send2trash>=1.8.2
+Requires-Dist: tomli>=2.0.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# devklean
+
+[![CI](https://github.com/smurftyy/devklean/actions/workflows/ci.yml/badge.svg)](https://github.com/smurftyy/devklean/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/devklean.svg)](https://pypi.org/project/devklean/)
+[![Python versions](https://img.shields.io/pypi/pyversions/devklean.svg)](https://pypi.org/project/devklean/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/smurftyy/devklean/blob/main/LICENSE)
+
+**Reclaim disk space by safely cleaning up development artifacts** — `node_modules`, `.venv`, build caches, and other regenerable directories — with a trash-backed safety net so nothing is ever lost to a typo.
+
+<!-- TODO: insert terminal recording GIF of `devklean clean` here -->
+
+## Why
+
+Development trees accumulate gigabytes of regenerable junk. `devklean` finds it, shows you exactly what it found and how big it is, and removes it **to your native system trash** — the Recycle Bin on Windows, Trash on macOS, the freedesktop trash on Linux — not `rm -rf`, so a mistaken delete is recoverable from your trash. It refuses to touch dangerous paths, makes large deletions require an explicit typed confirmation, and keeps a history of what it removed.
+
+## Installation
+
+```bash
+# Recommended: isolated install as a standalone CLI tool
+pipx install devklean
+
+# Or into the current environment
+pip install devklean
+```
+
+Requires Python 3.8+. Runtime dependencies are `send2trash` (used for all deletions) and `tomli` (only on Python < 3.11).
+
+## Quick start
+
+```bash
+# See what could be cleaned under the current directory — no changes made
+devklean scan
+
+# Scan and delete (with confirmation), moving items to the trash
+devklean clean
+
+# Preview a clean without deleting anything
+devklean clean --dry-run
+```
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `devklean scan [PATH]` | Find cleanable directories and report sizes. Never deletes. |
+| `devklean clean [PATH]` | Scan, then delete (to trash) after confirmation. |
+| `devklean restore` | Explain how to recover deleted items from your system trash. |
+| `devklean history` | Show previous cleanup operations (timestamp, size, strategy, item count). |
+| `devklean doctor` | Inspect and repair the deletion metadata store. |
+| `devklean --version` | Print the version. |
+
+**Default command:** running `devklean` with no subcommand defaults to `clean` — so `devklean` is `devklean clean`, and `devklean ~/code` is `devklean clean ~/code`. As a convenience, a bare `devklean --dry-run` (without `-i`) is treated as a `scan` preview.
+
+### `scan`
+
+```bash
+devklean scan                 # scan current directory
+devklean scan ~/projects      # scan a specific path
+devklean scan --json          # machine-readable output for tooling
+```
+
+### `clean`
+
+```bash
+devklean clean                  # scan + delete with a y/N confirmation
+devklean clean ~/projects       # clean a specific path
+devklean clean --dry-run        # show what *would* be deleted; delete nothing
+devklean clean -i               # interactive: pick items in a TUI (Linux/macOS only)
+devklean clean --allow-symlinks # permit deleting symlinked targets (blocked by default)
+devklean clean -y               # skip the y/N prompt (large deletions still require typing DELETE)
+```
+
+| Flag | Meaning |
+| --- | --- |
+| `--dry-run` | Report what would be deleted; make no changes. Output says "would delete". |
+| `-i`, `--interactive` | Choose items in a terminal UI (SPACE select, A all, D none, ENTER confirm, Q quit). **Linux/macOS only** — see [Platform support](#platform-support). |
+| `--allow-symlinks` | Allow deleting symbolic links. Off by default (symlinks are blocked). |
+| `-y`, `--yes` | Skip the standard confirmation. Deletions over the size threshold still require typing `DELETE`. |
+
+### `restore`
+
+devklean moves items to your operating system's own trash, which the OS owns —
+so recovery is done through your file manager's trash, not through devklean.
+This command just shows you how:
+
+```bash
+devklean restore   # explains how to recover from the Recycle Bin / Trash
+```
+
+- **Windows** — open the Recycle Bin and restore the item.
+- **macOS** — open Trash in Finder and "Put Back".
+- **Linux** — open Trash in your file manager and restore.
+
+Run `devklean history` to see what was removed and when.
+
+### `history`
+
+```bash
+devklean history          # human-readable table of past cleanups
+devklean history --json   # machine-readable
+```
+
+### `doctor`
+
+```bash
+devklean doctor        # report corrupt metadata; prompt before removing it
+devklean doctor --yes  # remove corrupt records without prompting
+```
+
+## Usage example
+
+```text
+$ devklean clean ~/code/my-app
+devklean scanning /home/me/code/my-app...
+
+TYPE                   SIZE  PATH
+──────────────────────────────────────────────────────────────────────
+Node.js              612.0 MB  /home/me/code/my-app/node_modules
+Python venv          188.0 MB  /home/me/code/my-app/.venv
+Build output          34.0 MB  /home/me/code/my-app/dist
+──────────────────────────────────────────────────────────────────────
+TOTAL                834.0 MB
+
+Delete 3 directories (~834.0 MB)? (y/N) y
+
+  ✓ /home/me/code/my-app/node_modules
+  ✓ /home/me/code/my-app/.venv
+  ✓ /home/me/code/my-app/dist
+
+✓ Cleaned 3 directories, freed ~834.0 MB.
+```
+
+<!-- TODO: insert terminal recording GIF of interactive mode (`devklean clean -i`) here -->
+
+## Platform support
+
+`devklean` runs on **Linux, macOS, and Windows**. All core commands — `scan`,
+`clean`, `history`, `doctor`, and `restore` — work on every platform.
+
+**Known limitation:** interactive mode (`-i` / `--interactive`) is **Linux/macOS
+only** for now. It is built on Python's `curses` module, which is not available
+on Windows. Running `devklean clean -i` on Windows prints a clear message and
+exits without making changes, rather than crashing — use `devklean clean`
+(non-interactive) instead. Windows support for interactive mode may come in a
+future release.
+
+## Configuration
+
+`devklean` reads TOML config with the precedence **project > global > built-in defaults**:
+
+1. A project file `.devklean.toml`, discovered by walking up from the current directory.
+2. The global file `~/.config/devklean/config.toml` (or `$XDG_CONFIG_HOME/devklean/config.toml`).
+
+```toml
+# ~/.config/devklean/config.toml or ./.devklean.toml
+
+# Directory names to never touch (merged into the ignore list)
+exclude = ["node_modules", ".git"]
+
+[defaults]
+dry_run = false
+interactive = false
+default_yes = false          # skip the y/N prompt (the large-deletion DELETE gate still applies)
+theme = "default"            # "default" or "mono"
+confirm_threshold = 1073741824   # bytes; deletions >= this require typing DELETE (default 1 GiB)
+path = "."
+
+[targets]
+exclude = ["dist"]           # remove built-in target *types*
+[targets.custom]
+".turbo" = "Turborepo cache" # add custom target directory types
+
+[ignore]
+paths = ["/keep/this/node_modules"]   # absolute paths to skip
+directories = ["vendor"]              # directory names to skip
+```
+
+Scalar keys from the project file override the global file; list keys (`exclude`, `ignore.*`) are unioned. Unknown keys and malformed TOML produce a warning rather than a crash.
+
+Color follows the `theme` setting and is automatically disabled when output is piped or `NO_COLOR` is set.
+
+## Logs
+
+`devklean` writes detailed structured logs (commands, scanned/deleted paths, sizes, errors) to:
+
+```
+~/.cache/devklean/logs/latest.log   # or $XDG_CACHE_HOME/devklean/logs/latest.log
+```
+
+Logs rotate (5 backups) and are kept entirely separate from terminal output.
+
+## FAQ
+
+**Why didn't it delete something?**
+`devklean` refuses to delete paths that should never be removed: the filesystem root, your home directory, mounted drive roots, protected system directories (`/etc`, `/usr`, …), and symbolic links. Symlinks can be allowed with `--allow-symlinks`. Each refusal prints the specific reason.
+
+**It asked me to type `DELETE` — why?**
+Deletions whose total size meets the `confirm_threshold` (default 1 GiB) require an explicit typed confirmation as an extra guard against large accidental deletes. This gate is intentionally **not** bypassed by `--yes` or `default_yes`; only `--dry-run` skips it.
+
+**Where do deleted files go? Can I get them back?**
+Items are moved to your operating system's native trash (Recycle Bin on Windows, Trash on macOS, the freedesktop trash on Linux), not permanently deleted. Recover them through your file manager's trash UI — devklean does not own that trash and can't move items back. Run `devklean history` to see what was removed, or `devklean restore` for recovery instructions.
+
+**How do I exclude a folder?**
+Add its name to `exclude` (global or project `.devklean.toml`), or an absolute path to `[ignore].paths`. See [Configuration](#configuration).
+
+**Where are the logs?**
+`~/.cache/devklean/logs/latest.log` (see [Logs](#logs)).
+
+**How do I turn off colors?**
+Set `NO_COLOR=1`, pipe the output, or set `theme = "mono"` in config.
+
+**Something looks wrong with my history data.**
+Run `devklean doctor` to detect and remove corrupt metadata records.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Bug reports and PRs are welcome.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

devklean-1.0.0.dist-info/RECORD

@@ -0,0 +1,49 @@
+devklean/__init__.py,sha256=ZGl68XBGj7V-2xjqilodvXiE_hn298QPRkgzR0VefsA,270
+devklean/__main__.py,sha256=kqUyX7bo1E6P8gwEAkb5E5K1CFyUPZoaEobocmSGFaI,69
+devklean/_version.py,sha256=3ntxAdhBWQkOtQ61NwSW-mQEEp4lHPrJOUeo8JZSAow,260
+devklean/formatting.py,sha256=GkzW0jot-WA2Y_mpv0R94LBH8bVxQnuJYAn8hK6k3cs,817
+devklean/logging_setup.py,sha256=MirR0UfG5NYhs9-Yq91wdB3zWXf6UF5bo_eOOb3PtC8,2433
+devklean/models.py,sha256=73QtNKOVOqp4oNP2Qcs1zvn_XqpxLo7zep0LN5fPi78,617
+devklean/tui.py,sha256=-UNRK0I36QXaCsUZEbty5Rx0K3o5exilXYwL3B6NpVQ,4164
+devklean/cli/__init__.py,sha256=g69W-cFS7OA24QUKcP5m3hSnaW86BUHExdwP01peLvg,55
+devklean/cli/confirmation.py,sha256=ldd_aaeiT0cEl6acRmHuB_UVz63zNLbxFfQ8jztU-t4,1905
+devklean/cli/dispatcher.py,sha256=jA3STlpE7YK-bKpbASflBPhG3UFzHrQvjiIQ1wicpaE,1504
+devklean/cli/main.py,sha256=in54Xq-vGJedKHjvOn6HpCIQbLLFTICb_6hgsMnTWM8,2184
+devklean/cli/parser.py,sha256=tBppyIBAFrU04tANctK-J6YTbakL7CQi05yC1w2A0YU,5086
+devklean/cli/commands/__init__.py,sha256=_cD7RwBtn3JGsJuL9T78jseExPlZvXhqmPinFc2dj9U,135
+devklean/cli/commands/clean.py,sha256=kUVUznlfW1-QwxMUv_hEg9RyT1FzZcpoOYSGC5kil6U,3321
+devklean/cli/commands/common.py,sha256=T5hVXFiXn7Jau9C5lLqHsLtoDslJW3GYyBle4pVKJO4,1064
+devklean/cli/commands/doctor.py,sha256=rHwBRV3_iInuPaBfNpG-GCNJYhQaQU9u-kIvfo1eX_g,1242
+devklean/cli/commands/history.py,sha256=DJenCPVZOUCNtUER6x9vxAna4Pet5FF9JPXYdBahvM4,539
+devklean/cli/commands/restore.py,sha256=YbOX3V9tarILxno0_bZCUwoayIggwE7plLq2M3QtLxI,670
+devklean/cli/commands/scan.py,sha256=X19cmAOA9-dALxcl_nDt_-ofnMvZrrW_nX8khoOy6Xg,539
+devklean/config/__init__.py,sha256=pCuU0p-6uksmnygP3fkoYXcVhwEx1fKedXqKb0SxMqI,440
+devklean/config/defaults.py,sha256=KrmYjMEgfLCFhkiLgi62e9piNP2YWSWz_Dzbb-4FegU,345
+devklean/config/manager.py,sha256=MDdOgdY4FtAUAxAIlK2Jw5cnf0C6cNA-v6hGLSoQxCM,7626
+devklean/config/models.py,sha256=5Z1ATDfC-M-c0cAhQhUWjG2BWNsXHLfzWVASAz1hDKA,1451
+devklean/config/paths.py,sha256=Fk3bIF4FXhAEKl0xx2fNtMaAWgYVwxapgg04AzUcWiI,765
+devklean/config/targets.py,sha256=-B2zqSt3GyKGdy-1lvbcwprTLoCC_4LsEjtT9Y_qle0,560
+devklean/deletion/__init__.py,sha256=71GdPX5t6YL5NtlfDuourQ9OqmPdEav_Vb21RcvFdh0,528
+devklean/deletion/history.py,sha256=tflDTVlEW9xvQtdrWfKTq42pJsdw9PjPkJfKR8I1Erk,1953
+devklean/deletion/integrity.py,sha256=nwavIjqz_eoG_OvrrrBwrwtAkhrCdexo9sT9p9mG9yI,1117
+devklean/deletion/metadata.py,sha256=HT5ApjDUB4hm1lHRZSOYtQpM1HyavWGSt152lM2nyh4,6278
+devklean/deletion/paths.py,sha256=eVOXIixkxTgsGehxtKIl9v9Xy2X4yBQAZG2X9W3CuNs,772
+devklean/deletion/safety.py,sha256=VPJynVy0id478nGDb6T0bEnhsG2Tm5bE9jrINAl2x4I,5621
+devklean/deletion/trash.py,sha256=fYafOvLYZisLvwoxbRE3s5X_0lhsxRPLu9D206CfKtc,3270
+devklean/output/__init__.py,sha256=qv0VEHgaRqYRq9R9p7wiv8luji-0qEsXv6Oiaky-C7w,190
+devklean/output/base.py,sha256=gzylNsCyv8WgIsAPTpnry4VvaaZpBWQEnzBB1ygA_Vg,1037
+devklean/output/console.py,sha256=CErmuXPmxXx-lotW_2Yzk5JcUWsk5G_JW-yXXDghKXc,2767
+devklean/output/history_payload.py,sha256=nKWs9lldXU1uW6CDPQGCrXgmUosFMcbnjKJ4jlehG5g,1156
+devklean/output/json.py,sha256=B7hvYFfDLhTFuuiw1_9KSAhIjN_lquABbSmTPk-I7-s,2273
+devklean/output/scan_payload.py,sha256=-DislAeiqFz8VzmjP9p5MNZwsmNLnEo_8pbGSKYdAFw,1381
+devklean/output/sorting.py,sha256=-3Y4xZNScFPznCIOUYMRBwTZ5NnZPZS_JTHgnetcmW4,434
+devklean/output/text.py,sha256=RXbNFEvVPKTAoo9PRurCbZ2pMqyiYShku61p2ssNXDw,7032
+devklean/output/theme.py,sha256=ryv0GjlKFD2STiUcjSo9z-pXvK6diZvShVwEnO6BfNY,922
+devklean/scanner/__init__.py,sha256=FY3fddVXtbawnn00a1XIGZiG_v6fH4S9OuGW7pcjYgI,414
+devklean/scanner/filters.py,sha256=LJnc-NiHFuqfwSZODxNuY63f8asbPYCmx3stlKx5fGg,1124
+devklean/scanner/scanner.py,sha256=5ZPze62Ush0eOZDKIcCrnwG-nGeNmQvqH2qXAtxrQL0,6784
+devklean-1.0.0.dist-info/METADATA,sha256=qcn7_7GzMeNduE9zHyEY_4XgyGCPppA4qsStBwRFnXg,11177
+devklean-1.0.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+devklean-1.0.0.dist-info/entry_points.txt,sha256=2sfmv0MdTQjlDndGdj5h9w2f-YTAHeL91Ibc8L-T_58,52
+devklean-1.0.0.dist-info/licenses/LICENSE,sha256=n1AGmToEZdT_uH_-ALQxahLbYSQKyURxtzAAm6GL8Mk,1065
+devklean-1.0.0.dist-info/RECORD,,

devklean-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

devklean-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+devklean = devklean.cli.main:main

devklean-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 smurftyy
+
+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.