recdelete 1.0.0__tar.gz

recdelete-1.0.0/LICENSE

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

recdelete-1.0.0/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: recdelete
+Version: 1.0.0
+Summary: Fast, secure, cross-platform recursive file/folder deletion tool
+Author-email: BSR <bhumasairam123@gmail.com>
+Maintainer-email: BSR <bhumasairam123@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/BhumaSai/cli-tool-recdelete
+Project-URL: Documentation, https://github.com/BhumaSai/cli-tool-recdelete#readme
+Project-URL: Repository, https://github.com/BhumaSai/cli-tool-recdelete.git
+Project-URL: Issues, https://github.com/BhumaSai/cli-tool-recdelete/issues
+Project-URL: Changelog, https://github.com/BhumaSai/cli-tool-recdelete/blob/main/CHANGELOG.md
+Project-URL: Funding, https://buymeacoffee.com/bhumasai
+Keywords: cli,delete,recursive,file-management,cleanup,node_modules,cache,cross-platform,fast,secure
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+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
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# 🗑️ RecDelete for Python
+
+[![PyPI version](https://img.shields.io/pypi/v/recdelete.svg)](https://pypi.org/project/recdelete/)
+[![Python Version](https://img.shields.io/pypi/pyversions/recdelete.svg)](https://pypi.org/project/recdelete/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **Fast, secure, cross-platform recursive file/folder deletion tool for Python**
+
+## 📥 Installation
+
+```bash
+pip install recdelete
+```
+
+The binary is automatically downloaded for your platform during installation.
+
+## 🚀 Quick Start
+
+### CLI
+
+```bash
+# Dry run (preview only)
+recdelete ./projects node_modules --dry-run
+
+# Actually delete
+recdelete ./projects node_modules --force
+
+# Delete log files
+recdelete ./logs "*.log" --only-files
+```
+
+### Python API
+
+```python
+from recdelete import delete, clean_node_modules, RecDelete
+
+# Simple delete
+result = delete("./projects", "node_modules", dry_run=True, only_dirs=True)
+print(f"Would delete {result.total_deleted} items")
+print(f"Would free {result.bytes_freed_human}")
+
+# Clean node_modules
+result = clean_node_modules("./projects", dry_run=True)
+```
+
+## 📖 API Reference
+
+### RecDelete Class
+
+```python
+from recdelete import RecDelete
+
+rd = RecDelete()
+
+# Main delete method
+result = rd.delete(
+    start_path="./projects",
+    target_name="node_modules",
+    dry_run=True,            # Preview only
+    only_dirs=True,          # Only directories
+    only_files=False,        # Only files
+    force=True,              # Skip confirmation
+    max_depth=None,          # None for unlimited
+    parallel=4,              # Worker count
+    include=["*.cache"],     # Include patterns
+    exclude=["*important*"], # Exclude patterns
+    verbose=False,           # Detailed output
+    log_file="./log.txt"     # Log to file
+)
+```
+
+### Convenience Functions
+
+```python
+from recdelete import (
+    delete,
+    scan,
+    clean_node_modules,
+    clean_python_cache,
+    clean_build_artifacts
+)
+
+# Scan (dry run)
+result = scan("./projects", "*.tmp")
+
+# Clean node_modules
+result = clean_node_modules("./projects", dry_run=True)
+
+# Clean Python cache (__pycache__, .pytest_cache, *.pyc)
+result = clean_python_cache("./projects")
+
+# Clean build artifacts (dist, build, .next, etc.)
+result = clean_build_artifacts("./projects")
+```
+
+### DeleteResult Class
+
+```python
+@dataclass
+class DeleteResult:
+    files_deleted: int       # Files deleted
+    dirs_deleted: int        # Directories deleted
+    files_matched: int       # Files matched
+    dirs_matched: int        # Directories matched
+    bytes_freed: int         # Bytes freed
+    bytes_freed_human: str   # Human-readable size (e.g., "1.5 GB")
+    items_scanned: int       # Total items scanned
+    errors: int              # Error count
+    deleted_paths: list      # List of deleted paths
+    error_messages: list     # List of error messages
+    start_path: str          # Start path
+    target_name: str         # Target pattern
+    dry_run: bool            # Was this a dry run
+    elapsed_ms: int          # Elapsed milliseconds
+    success: bool            # Success status
+    
+    @property
+    def total_deleted(self) -> int:
+        """Total deleted items (files + directories)."""
+        return self.files_deleted + self.dirs_deleted
+```
+
+## 💡 Examples
+
+### Clean Up Node.js Projects
+
+```python
+from recdelete import clean_node_modules
+
+# Preview what would be deleted
+preview = clean_node_modules("./projects", dry_run=True)
+print(f"Would free {preview.bytes_freed_human}")
+
+# Actually delete
+result = clean_node_modules("./projects")
+print(f"Freed {result.bytes_freed_human}!")
+```
+
+### Delete Log Files
+
+```python
+from recdelete import delete
+
+result = delete(
+    "./logs",
+    "*.log",
+    only_files=True,
+    exclude=["*important*", "*backup*"],
+    dry_run=True
+)
+
+print(f"Found {result.files_matched} log files")
+for path in result.deleted_paths:
+    print(f"  - {path}")
+```
+
+### Clean Python Project
+
+```python
+from recdelete import clean_python_cache, clean_build_artifacts
+
+# Clean all Python cache
+result = clean_python_cache("./my_project")
+print(f"Cleaned {result.total_deleted} cache items")
+
+# Clean build artifacts
+result = clean_build_artifacts("./my_project")
+print(f"Removed {result.dirs_deleted} build directories")
+```
+
+### Using with Context
+
+```python
+from recdelete import RecDelete
+
+# Create instance once, reuse
+rd = RecDelete()
+
+# Multiple operations
+for project in ["./project1", "./project2", "./project3"]:
+    result = rd.clean_node_modules(project, dry_run=False)
+    print(f"{project}: Freed {result.bytes_freed_human}")
+```
+
+## 🛡️ Security
+
+- **Protected Paths**: System directories (`/`, `C:\Windows`, etc.) cannot be deleted
+- **Symbolic Links**: Not followed to prevent escaping directories
+- **Dry Run**: Always preview with `dry_run=True` first
+- **Confirmation**: Requires confirmation unless `force=True` is used
+
+## 🔗 Links
+
+- **GitHub**: [https://github.com/BhumaSai/cli-tool-recdelete](https://github.com/BhumaSai/cli-tool-recdelete)
+- **PyPI**: [https://pypi.org/project/recdelete/](https://pypi.org/project/recdelete/)
+
+## ☕ Support
+
+[Buy Me a Coffee](https://buymeacoffee.com/bhumasai)
+
+## 📜 License
+
+MIT License - see [LICENSE](LICENSE) for details.

recdelete-1.0.0/README.md

@@ -0,0 +1,203 @@
+# 🗑️ RecDelete for Python
+
+[![PyPI version](https://img.shields.io/pypi/v/recdelete.svg)](https://pypi.org/project/recdelete/)
+[![Python Version](https://img.shields.io/pypi/pyversions/recdelete.svg)](https://pypi.org/project/recdelete/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **Fast, secure, cross-platform recursive file/folder deletion tool for Python**
+
+## 📥 Installation
+
+```bash
+pip install recdelete
+```
+
+The binary is automatically downloaded for your platform during installation.
+
+## 🚀 Quick Start
+
+### CLI
+
+```bash
+# Dry run (preview only)
+recdelete ./projects node_modules --dry-run
+
+# Actually delete
+recdelete ./projects node_modules --force
+
+# Delete log files
+recdelete ./logs "*.log" --only-files
+```
+
+### Python API
+
+```python
+from recdelete import delete, clean_node_modules, RecDelete
+
+# Simple delete
+result = delete("./projects", "node_modules", dry_run=True, only_dirs=True)
+print(f"Would delete {result.total_deleted} items")
+print(f"Would free {result.bytes_freed_human}")
+
+# Clean node_modules
+result = clean_node_modules("./projects", dry_run=True)
+```
+
+## 📖 API Reference
+
+### RecDelete Class
+
+```python
+from recdelete import RecDelete
+
+rd = RecDelete()
+
+# Main delete method
+result = rd.delete(
+    start_path="./projects",
+    target_name="node_modules",
+    dry_run=True,            # Preview only
+    only_dirs=True,          # Only directories
+    only_files=False,        # Only files
+    force=True,              # Skip confirmation
+    max_depth=None,          # None for unlimited
+    parallel=4,              # Worker count
+    include=["*.cache"],     # Include patterns
+    exclude=["*important*"], # Exclude patterns
+    verbose=False,           # Detailed output
+    log_file="./log.txt"     # Log to file
+)
+```
+
+### Convenience Functions
+
+```python
+from recdelete import (
+    delete,
+    scan,
+    clean_node_modules,
+    clean_python_cache,
+    clean_build_artifacts
+)
+
+# Scan (dry run)
+result = scan("./projects", "*.tmp")
+
+# Clean node_modules
+result = clean_node_modules("./projects", dry_run=True)
+
+# Clean Python cache (__pycache__, .pytest_cache, *.pyc)
+result = clean_python_cache("./projects")
+
+# Clean build artifacts (dist, build, .next, etc.)
+result = clean_build_artifacts("./projects")
+```
+
+### DeleteResult Class
+
+```python
+@dataclass
+class DeleteResult:
+    files_deleted: int       # Files deleted
+    dirs_deleted: int        # Directories deleted
+    files_matched: int       # Files matched
+    dirs_matched: int        # Directories matched
+    bytes_freed: int         # Bytes freed
+    bytes_freed_human: str   # Human-readable size (e.g., "1.5 GB")
+    items_scanned: int       # Total items scanned
+    errors: int              # Error count
+    deleted_paths: list      # List of deleted paths
+    error_messages: list     # List of error messages
+    start_path: str          # Start path
+    target_name: str         # Target pattern
+    dry_run: bool            # Was this a dry run
+    elapsed_ms: int          # Elapsed milliseconds
+    success: bool            # Success status
+    
+    @property
+    def total_deleted(self) -> int:
+        """Total deleted items (files + directories)."""
+        return self.files_deleted + self.dirs_deleted
+```
+
+## 💡 Examples
+
+### Clean Up Node.js Projects
+
+```python
+from recdelete import clean_node_modules
+
+# Preview what would be deleted
+preview = clean_node_modules("./projects", dry_run=True)
+print(f"Would free {preview.bytes_freed_human}")
+
+# Actually delete
+result = clean_node_modules("./projects")
+print(f"Freed {result.bytes_freed_human}!")
+```
+
+### Delete Log Files
+
+```python
+from recdelete import delete
+
+result = delete(
+    "./logs",
+    "*.log",
+    only_files=True,
+    exclude=["*important*", "*backup*"],
+    dry_run=True
+)
+
+print(f"Found {result.files_matched} log files")
+for path in result.deleted_paths:
+    print(f"  - {path}")
+```
+
+### Clean Python Project
+
+```python
+from recdelete import clean_python_cache, clean_build_artifacts
+
+# Clean all Python cache
+result = clean_python_cache("./my_project")
+print(f"Cleaned {result.total_deleted} cache items")
+
+# Clean build artifacts
+result = clean_build_artifacts("./my_project")
+print(f"Removed {result.dirs_deleted} build directories")
+```
+
+### Using with Context
+
+```python
+from recdelete import RecDelete
+
+# Create instance once, reuse
+rd = RecDelete()
+
+# Multiple operations
+for project in ["./project1", "./project2", "./project3"]:
+    result = rd.clean_node_modules(project, dry_run=False)
+    print(f"{project}: Freed {result.bytes_freed_human}")
+```
+
+## 🛡️ Security
+
+- **Protected Paths**: System directories (`/`, `C:\Windows`, etc.) cannot be deleted
+- **Symbolic Links**: Not followed to prevent escaping directories
+- **Dry Run**: Always preview with `dry_run=True` first
+- **Confirmation**: Requires confirmation unless `force=True` is used
+
+## 🔗 Links
+
+- **GitHub**: [https://github.com/BhumaSai/cli-tool-recdelete](https://github.com/BhumaSai/cli-tool-recdelete)
+- **PyPI**: [https://pypi.org/project/recdelete/](https://pypi.org/project/recdelete/)
+
+## ☕ Support
+
+[Buy Me a Coffee](https://buymeacoffee.com/bhumasai)
+
+## 📜 License
+
+MIT License - see [LICENSE](LICENSE) for details.

recdelete-1.0.0/pyproject.toml

@@ -0,0 +1,100 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "recdelete"
+version = "1.0.0"
+description = "Fast, secure, cross-platform recursive file/folder deletion tool"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "BSR", email = "bhumasairam123@gmail.com"}
+]
+maintainers = [
+    {name = "BSR", email = "bhumasairam123@gmail.com"}
+]
+keywords = [
+    "cli",
+    "delete",
+    "recursive",
+    "file-management",
+    "cleanup",
+    "node_modules",
+    "cache",
+    "cross-platform",
+    "fast",
+    "secure"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Filesystems",
+    "Topic :: Utilities",
+    "Typing :: Typed"
+]
+requires-python = ">=3.8"
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "black>=23.0",
+    "mypy>=1.0",
+    "ruff>=0.1.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/BhumaSai/cli-tool-recdelete"
+Documentation = "https://github.com/BhumaSai/cli-tool-recdelete#readme"
+Repository = "https://github.com/BhumaSai/cli-tool-recdelete.git"
+Issues = "https://github.com/BhumaSai/cli-tool-recdelete/issues"
+Changelog = "https://github.com/BhumaSai/cli-tool-recdelete/blob/main/CHANGELOG.md"
+Funding = "https://buymeacoffee.com/bhumasai"
+
+[project.scripts]
+recdelete = "recdelete.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+recdelete = ["bin/*", "py.typed"]
+
+[tool.black]
+line-length = 100
+target-version = ["py38", "py39", "py310", "py311", "py312"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py38"
+select = ["E", "F", "W", "I", "N", "UP", "B", "C4"]
+
+[tool.mypy]
+python_version = "3.8"
+strict = true
+warn_return_any = true
+warn_unused_ignores = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+addopts = "-v --cov=recdelete --cov-report=term-missing"

recdelete-1.0.0/setup.cfg

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

recdelete-1.0.0/setup.py

@@ -0,0 +1,54 @@
+"""
+Setup script for recdelete Python package.
+Handles post-install binary download.
+"""
+
+import subprocess
+import sys
+from pathlib import Path
+from setuptools import setup
+from setuptools.command.install import install
+from setuptools.command.develop import develop
+
+
+class PostInstallCommand(install):
+    """Post-installation: download binary."""
+    def run(self):
+        install.run(self)
+        self._post_install()
+    
+    def _post_install(self):
+        """Download the binary after installation."""
+        try:
+            script_path = Path(__file__).parent / "scripts" / "postinstall.py"
+            if script_path.exists():
+                subprocess.run([sys.executable, str(script_path)], check=False)
+        except Exception as e:
+            print(f"Note: Could not run postinstall script: {e}")
+            print("You may need to manually download the binary.")
+
+
+class PostDevelopCommand(develop):
+    """Post-development install: download binary."""
+    def run(self):
+        develop.run(self)
+        self._post_install()
+    
+    def _post_install(self):
+        """Download the binary after installation."""
+        try:
+            script_path = Path(__file__).parent / "scripts" / "postinstall.py"
+            if script_path.exists():
+                subprocess.run([sys.executable, str(script_path)], check=False)
+        except Exception as e:
+            print(f"Note: Could not run postinstall script: {e}")
+
+
+# This setup.py is minimal - most config is in pyproject.toml
+# It exists only to provide custom install commands
+setup(
+    cmdclass={
+        'install': PostInstallCommand,
+        'develop': PostDevelopCommand,
+    },
+)

recdelete-1.0.0/src/recdelete/__init__.py

@@ -0,0 +1,61 @@
+"""
+RecDelete - Fast, secure, cross-platform recursive file/folder deletion tool.
+
+A Python wrapper for the recdelete Go binary, providing both CLI and
+programmatic access to powerful file deletion capabilities.
+
+Installation:
+    pip install recdelete
+
+Quick Start:
+    >>> from recdelete import delete, clean_node_modules
+    >>> 
+    >>> # Dry run first (safe - doesn't delete anything)
+    >>> result = delete("./projects", "node_modules", dry_run=True)
+    >>> print(f"Would delete {result.total_deleted} items, freeing {result.bytes_freed_human}")
+    >>>
+    >>> # Clean up node_modules in all projects
+    >>> result = clean_node_modules("./projects", dry_run=False)
+
+CLI Usage:
+    recdelete ./projects node_modules --dry-run
+    recdelete ./projects "*.log" --only-files --force
+
+Links:
+    - GitHub: https://github.com/BhumaSai/cli-tool-recdelete
+    - PyPI: https://pypi.org/project/recdelete/
+    - Buy Me a Coffee: https://buymeacoffee.com/bhumasai
+"""
+
+__version__ = "1.0.0"
+__author__ = "BSR"
+__email__ = "bhumasairam123@gmail.com"
+__license__ = "MIT"
+
+from recdelete.api import (
+    RecDelete,
+    DeleteResult,
+    delete,
+    scan,
+    clean_node_modules,
+    clean_python_cache,
+    clean_build_artifacts,
+)
+
+__all__ = [
+    # Main class
+    "RecDelete",
+    # Result type
+    "DeleteResult",
+    # Convenience functions
+    "delete",
+    "scan",
+    "clean_node_modules",
+    "clean_python_cache",
+    "clean_build_artifacts",
+    # Metadata
+    "__version__",
+    "__author__",
+    "__email__",
+    "__license__",
+]