A tool to generate a project tree and extract file contents.
Project description
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
:
pip install projectcompactor
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
projectcompactor-0.2.0.tar.gz
(5.1 kB
view hashes)
Built Distribution
Close
Hashes for projectcompactor-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d84628b2234a3d4d9dfee2d260af4b0dce2e27ea21fba024aa778151640a41f |
|
MD5 | 30070b7769935c1f281b451faa63c9bf |
|
BLAKE2b-256 | f5ba437491f61f2dc38f540bb6a9dc7bb90b122399bfe85f81022fc9ab83a708 |