# ProjectCompactor
**ProjectCompactor** is a Python tool that generates a hierarchical project structure of a given directory. It includes the contents of text-based files and lists binary or non-text files without attempting to read them.
## Features
- **Recursive Directory Traversal:** Walk through all subdirectories.
- **Comprehensive File Type Handling:** Supports a wide range of text-based file extensions.
- **Configurable Text File Extensions:** Specify additional file extensions to treat as text files.
- **File Content Extraction:** Includes contents for text-based files.
- **Binary File Handling:** Identifies and lists binary or non-text files without attempting to read them.
- **Exclusion Filters:** Exclude specific directories or file types from the analysis.
- **Customizable Output:** Specify the output file name and target directory.
- **Progress Indicators:** Displays a progress bar while processing files.
- **Command-Line Interface:** Easy-to-use CLI with multiple options.
- **Verbose Logging:** Enable detailed logging for debugging purposes.
## Installation
You can install **ProjectCompactor** using `pip`:
```bash
pip install projectcompactor
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/projectcompactor",
"name": "projectcompactor",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/f2/1d/1486fc48898b36a475106537bab6d68b9568d66febd9c4840898b6995148/projectcompactor-0.2.0.tar.gz",
"platform": null,
"description": "# ProjectCompactor\n\n**ProjectCompactor** is a Python tool that generates a hierarchical project structure of a given directory. It includes the contents of text-based files and lists binary or non-text files without attempting to read them.\n\n## Features\n\n- **Recursive Directory Traversal:** Walk through all subdirectories.\n- **Comprehensive File Type Handling:** Supports a wide range of text-based file extensions.\n- **Configurable Text File Extensions:** Specify additional file extensions to treat as text files.\n- **File Content Extraction:** Includes contents for text-based files.\n- **Binary File Handling:** Identifies and lists binary or non-text files without attempting to read them.\n- **Exclusion Filters:** Exclude specific directories or file types from the analysis.\n- **Customizable Output:** Specify the output file name and target directory.\n- **Progress Indicators:** Displays a progress bar while processing files.\n- **Command-Line Interface:** Easy-to-use CLI with multiple options.\n- **Verbose Logging:** Enable detailed logging for debugging purposes.\n\n## Installation\n\nYou can install **ProjectCompactor** using `pip`:\n\n```bash\npip install projectcompactor\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool to generate a project tree and extract file contents.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/yourusername/projectcompactor"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5ba437491f61f2dc38f540bb6a9dc7bb90b122399bfe85f81022fc9ab83a708",
"md5": "30070b7769935c1f281b451faa63c9bf",
"sha256": "5d84628b2234a3d4d9dfee2d260af4b0dce2e27ea21fba024aa778151640a41f"
},
"downloads": -1,
"filename": "projectcompactor-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "30070b7769935c1f281b451faa63c9bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5172,
"upload_time": "2024-10-01T15:17:22",
"upload_time_iso_8601": "2024-10-01T15:17:22.570464Z",
"url": "https://files.pythonhosted.org/packages/f5/ba/437491f61f2dc38f540bb6a9dc7bb90b122399bfe85f81022fc9ab83a708/projectcompactor-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f21d1486fc48898b36a475106537bab6d68b9568d66febd9c4840898b6995148",
"md5": "ca0e812f5a8c201e718b64eff48aa797",
"sha256": "5c59b9f9e3c00f3cb3220ee819e3eee5d3ea53004d3fd136c04b0a6cbdd1a640"
},
"downloads": -1,
"filename": "projectcompactor-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ca0e812f5a8c201e718b64eff48aa797",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5147,
"upload_time": "2024-10-01T15:17:23",
"upload_time_iso_8601": "2024-10-01T15:17:23.685509Z",
"url": "https://files.pythonhosted.org/packages/f2/1d/1486fc48898b36a475106537bab6d68b9568d66febd9c4840898b6995148/projectcompactor-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 15:17:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "projectcompactor",
"github_not_found": true,
"lcname": "projectcompactor"
}
JSON
