| Name | junk-remover-cli JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Universal cleanup executor - Automated deletion of unwanted files and directories |
| upload_time | 2025-08-23 21:13:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License
Copyright (c) 2025 Junk CLI
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. |
| keywords |
automation
cleanup
cli
delete
devtools
files
junk
universal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Junk - Universal Cleanup Executor
A zero-friction Python CLI tool for automated cleanup of unwanted files and directories.
## Problem Statement
Development repositories often accumulate unwanted files and directories:
- `/target/` build directories
- `*.log` files
- `__pycache__/` Python cache directories
- `/temp/` temporary directories
- Build artifacts and cache files
Manual deletion of these files is time-consuming and error-prone. Organizations need an automated solution that works universally across different project types and environments.
## Solution Overview
**Junk** is a PyPI-distributed command-line tool that provides automated cleanup with zero user intervention required.
Execute with a single command:
```bash
junk
```
The tool operates by:
1. Locating a `junk.fat` configuration file in the current directory
2. Reading the specified list of files and directories for removal
3. Executing deletions as specified
4. Self-removing the configuration file upon successful completion
## Installation
Install from the Python Package Index:
```bash
pip install junk-remover-cli
```
The tool is immediately available system-wide:
```bash
junk
```
## Usage Instructions
### Step 1: Create Configuration File
Create a `junk.fat` file in your project root directory. List files and directories to be removed, one per line:
```
/target/
/Server/plotter/output/main.png
/Server/temp/arch.json
__pycache__/
*.log
node_modules/
.DS_Store
```
### Step 2: Execute Cleanup
Run the cleanup command:
```bash
junk
```
### Step 3: Verification
All specified items are removed, and the `junk.fat` configuration file is automatically deleted upon successful completion.
## Key Features
- **Zero User Interaction**: No confirmation prompts or manual intervention required
- **Universal Compatibility**: Functions in any directory containing a `junk.fat` configuration file
- **Self-Managing**: Automatically removes configuration file after successful execution
- **Error Handling**: Preserves configuration file when deletions fail for retry capability
- **Cross-Platform**: Compatible with Windows, macOS, and Linux environments
- **Encoding Support**: Handles multiple file encodings automatically
## Operational Behavior
### Success Case
When all specified items are successfully deleted, the `junk.fat` configuration file is automatically removed.
### Partial Failure Case
When some items cannot be deleted, the `junk.fat` configuration file is preserved to allow for retry operations.
### Missing Configuration Case
When no `junk.fat` file is present, the tool exits gracefully with an informative status message.
## Integration with Development Workflows
This tool is designed for integration with automated development workflows:
- **Configuration Generation**: AI code assistants or scripts generate project-specific `junk.fat` files
- **Execution**: The junk tool executes cleanup operations without human intervention
- **Universal Application**: Consistent workflow across different programming languages and project types
## Configuration Examples
### Web Development Projects
```
node_modules/
dist/
.cache/
*.log
.DS_Store
```
### Python Projects
```
__pycache__/
*.pyc
.pytest_cache/
build/
*.egg-info/
```
### Java Projects
```
target/
*.class
*.jar
*.war
```
## Safety and Security
- Operations are limited to explicitly listed items in the configuration file
- No wildcard expansion or pattern matching beyond exact path specification
- Non-existent files and directories are gracefully ignored
- Comprehensive logging provides clear feedback on all operations performed
## License
This project is distributed under the MIT License. See the LICENSE file for complete terms and conditions.
## Contributing
Contributions are welcome through standard open-source channels. This tool maintains a focused scope centered on the core principle of zero-friction cleanup execution. Please ensure any proposed changes align with this fundamental design philosophy.
## Support
For issues, feature requests, or technical support, please utilize the project's issue tracking system on the source code repository.
---
**Junk CLI**: Making cleanup operations universal, automated, and reliable.
Raw data
{
"_id": null,
"home_page": null,
"name": "junk-remover-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "automation, cleanup, cli, delete, devtools, files, junk, universal",
"author": null,
"author_email": "Junk CLI <maintainer@junk-cli.dev>",
"download_url": "https://files.pythonhosted.org/packages/29/d3/d7058b0fb855f98d0993b2c5ee4e3fbd670ff9b15ee34615d7033bb4ffae/junk_remover_cli-0.1.3.tar.gz",
"platform": null,
"description": "\n# Junk - Universal Cleanup Executor\n\nA zero-friction Python CLI tool for automated cleanup of unwanted files and directories.\n\n## Problem Statement\n\nDevelopment repositories often accumulate unwanted files and directories:\n- `/target/` build directories\n- `*.log` files\n- `__pycache__/` Python cache directories \n- `/temp/` temporary directories\n- Build artifacts and cache files\n\nManual deletion of these files is time-consuming and error-prone. Organizations need an automated solution that works universally across different project types and environments.\n\n## Solution Overview\n\n**Junk** is a PyPI-distributed command-line tool that provides automated cleanup with zero user intervention required.\n\nExecute with a single command:\n```bash\njunk\n```\n\nThe tool operates by:\n1. Locating a `junk.fat` configuration file in the current directory\n2. Reading the specified list of files and directories for removal\n3. Executing deletions as specified\n4. Self-removing the configuration file upon successful completion\n\n## Installation\n\nInstall from the Python Package Index:\n```bash\npip install junk-remover-cli\n```\n\nThe tool is immediately available system-wide:\n```bash\njunk\n```\n\n## Usage Instructions\n\n### Step 1: Create Configuration File\n\nCreate a `junk.fat` file in your project root directory. List files and directories to be removed, one per line:\n\n```\n/target/\n/Server/plotter/output/main.png\n/Server/temp/arch.json\n__pycache__/\n*.log\nnode_modules/\n.DS_Store\n```\n\n### Step 2: Execute Cleanup\n\nRun the cleanup command:\n```bash\njunk\n```\n\n### Step 3: Verification\n\nAll specified items are removed, and the `junk.fat` configuration file is automatically deleted upon successful completion.\n\n## Key Features\n\n- **Zero User Interaction**: No confirmation prompts or manual intervention required\n- **Universal Compatibility**: Functions in any directory containing a `junk.fat` configuration file\n- **Self-Managing**: Automatically removes configuration file after successful execution\n- **Error Handling**: Preserves configuration file when deletions fail for retry capability\n- **Cross-Platform**: Compatible with Windows, macOS, and Linux environments\n- **Encoding Support**: Handles multiple file encodings automatically\n\n## Operational Behavior\n\n### Success Case\nWhen all specified items are successfully deleted, the `junk.fat` configuration file is automatically removed.\n\n### Partial Failure Case \nWhen some items cannot be deleted, the `junk.fat` configuration file is preserved to allow for retry operations.\n\n### Missing Configuration Case\nWhen no `junk.fat` file is present, the tool exits gracefully with an informative status message.\n\n## Integration with Development Workflows\n\nThis tool is designed for integration with automated development workflows:\n- **Configuration Generation**: AI code assistants or scripts generate project-specific `junk.fat` files\n- **Execution**: The junk tool executes cleanup operations without human intervention\n- **Universal Application**: Consistent workflow across different programming languages and project types\n\n## Configuration Examples\n\n### Web Development Projects\n```\nnode_modules/\ndist/\n.cache/\n*.log\n.DS_Store\n```\n\n### Python Projects\n```\n__pycache__/\n*.pyc\n.pytest_cache/\nbuild/\n*.egg-info/\n```\n\n### Java Projects\n```\ntarget/\n*.class\n*.jar\n*.war\n```\n\n## Safety and Security\n\n- Operations are limited to explicitly listed items in the configuration file\n- No wildcard expansion or pattern matching beyond exact path specification\n- Non-existent files and directories are gracefully ignored\n- Comprehensive logging provides clear feedback on all operations performed\n\n## License\n\nThis project is distributed under the MIT License. See the LICENSE file for complete terms and conditions.\n\n## Contributing\n\nContributions are welcome through standard open-source channels. This tool maintains a focused scope centered on the core principle of zero-friction cleanup execution. Please ensure any proposed changes align with this fundamental design philosophy.\n\n## Support\n\nFor issues, feature requests, or technical support, please utilize the project's issue tracking system on the source code repository.\n\n---\n\n**Junk CLI**: Making cleanup operations universal, automated, and reliable.",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Junk CLI\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Universal cleanup executor - Automated deletion of unwanted files and directories",
"version": "0.1.3",
"project_urls": {
"Bug Reports": "https://github.com/AuraCulture/Junk/issues",
"Documentation": "https://github.com/AuraCulture/Junk#readme",
"Homepage": "https://github.com/AuraCulture/Junk",
"Source": "https://github.com/AuraCulture/Junk"
},
"split_keywords": [
"automation",
" cleanup",
" cli",
" delete",
" devtools",
" files",
" junk",
" universal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fa2cf83bd410249cb56b81c5b2a748636782de323dac95a29418b6a4827a314a",
"md5": "a737c0f730a580b58db2ff716b29aa88",
"sha256": "c5db98ca9b900db9d06c192f09a910617960d106b4233501dd883aa4a20356d1"
},
"downloads": -1,
"filename": "junk_remover_cli-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a737c0f730a580b58db2ff716b29aa88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6815,
"upload_time": "2025-08-23T21:13:15",
"upload_time_iso_8601": "2025-08-23T21:13:15.345119Z",
"url": "https://files.pythonhosted.org/packages/fa/2c/f83bd410249cb56b81c5b2a748636782de323dac95a29418b6a4827a314a/junk_remover_cli-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "29d3d7058b0fb855f98d0993b2c5ee4e3fbd670ff9b15ee34615d7033bb4ffae",
"md5": "d8e7901a763495b4c0d3b61d250d3f4d",
"sha256": "5af051311ed709bfc23add103691a63bbb36f600f129acd5889cda89fef11c76"
},
"downloads": -1,
"filename": "junk_remover_cli-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "d8e7901a763495b4c0d3b61d250d3f4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5922,
"upload_time": "2025-08-23T21:13:16",
"upload_time_iso_8601": "2025-08-23T21:13:16.799322Z",
"url": "https://files.pythonhosted.org/packages/29/d3/d7058b0fb855f98d0993b2c5ee4e3fbd670ff9b15ee34615d7033bb4ffae/junk_remover_cli-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-23 21:13:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AuraCulture",
"github_project": "Junk",
"github_not_found": true,
"lcname": "junk-remover-cli"
}
