jordanlambrecht / foldermapper

A python script that generates a visual tree map of folders

FolderMapper

FolderMapper is a Python tool that generates a color-coded tree map of a directory structure, providing a visual representation of the folder hierarchy and file organization.

Features

• Generate a tree map of a directory structure.
• Optional display of file names and hidden files.
• Configurable depth limit and file count limit.
• Color-coded output based on folder depth.
• Support for exporting the tree map to JSON, Markdown, or text file.
• Automatic creation of virtual environment and installation of required packages.

Installation

1. Clone the repository:

   git clone https://github.com/jordanlambrecht/foldermapper.git

2. Navigate to the project directory:

   ```bash
   cd foldermapper
   ```

3. Run the script:
   ```bash
   python3 foldermapper.py
   ```

## Usage

Follow the prompts to enter the path to the root directory, configure options, and generate the tree map.

## Contributing

Contributions are welcome! Feel free to submit issues or pull requests to improve the functionality or documentation of FolderMapper.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

You can copy and paste this Markdown content into your README.md file for your GitHub repository.