GitHunt
IB

ibrahimahtsham/ascii-file-structure-maker-and-lines-of-code-reader

Modern Python GUI tool for generating ASCII file trees and copying entire codebases. Perfect for sharing project structures with AI assistants, code reviews, and documentation. Features dark theme, statistics, and cross-platform executable builds.

File Structure Viewer - ASCII Tree Generator & Code Copier

A modern Python GUI application that helps developers easily copy entire codebases with file structures to share with AI assistants like ChatGPT. Perfect for getting code reviews, debugging help, or architectural advice.

โœจ Features

  • ๐Ÿ“ Browse & Analyze - Select any folder and instantly see its structure
  • ๐ŸŒณ ASCII Tree Generation - Beautiful tree visualization of your project structure
  • ๐Ÿ“„ Smart File Copying - Copy individual files or entire codebases with proper formatting
  • ๐Ÿ“Š Project Statistics - View file counts, lines of code, and file type distributions
  • ๐ŸŽจ Modern Dark Theme - Clean, professional interface that's easy on the eyes
  • โšก Fast & Lightweight - Built with Python Tkinter for optimal performance
  • ๐Ÿ” Folder Filtering - Ignore common folders like node_modules, .git, __pycache__

๐Ÿ–ผ๏ธ Version Comparison

Previous Version (v2)

Old Version

Current Version (v3) - Modern UI

image

๐Ÿš€ Quick Start

Prerequisites

  • Python 3.7 or higher
  • pip package manager

Installation & Usage

  1. Clone the repository

    git clone https://github.com/ibrahimahtsham/ascii-file-structure-maker-and-lines-of-code-reader.git
    cd ascii-file-structure-maker-and-lines-of-code-reader
  2. Install dependencies

    pip install -r requirements.txt
    # or manually:
    pip install pyperclip cx_Freeze
  3. Run the application

    python main.py

Building Executable

Windows:

run_project.bat

Linux:

chmod +x build_linux.sh
./build_linux.sh

๐Ÿ’ก Use Cases

  • AI-Assisted Development - Share your entire codebase structure with ChatGPT, Claude, or other AI assistants
  • Code Reviews - Quickly share project structure and specific files with team members
  • Documentation - Generate ASCII tree representations for README files or documentation
  • Project Analysis - Get insights into your project's file distribution and size
  • Learning - Understand the structure of open-source projects

๐Ÿ› ๏ธ Technical Stack

  • GUI Framework: Python Tkinter with custom modern theme
  • File Operations: Native Python os and pathlib modules
  • Clipboard Integration: pyperclip for seamless copy operations
  • Build System: cx_Freeze for cross-platform executable generation

๐Ÿ“‹ Project Structure

ascii-file-structure-maker-and-lines-of-code-reader/
โ”œโ”€โ”€ main.py                 # Application entry point
โ”œโ”€โ”€ controllers/            # Business logic
โ”‚   โ””โ”€โ”€ main_controller.py
โ”œโ”€โ”€ models/                 # Data management
โ”‚   โ””โ”€โ”€ file_manager.py
โ”œโ”€โ”€ views/                  # UI components
โ”‚   โ”œโ”€โ”€ main_window.py
โ”‚   โ””โ”€โ”€ components/
โ”‚       โ””โ”€โ”€ header_panel.py
โ”œโ”€โ”€ utils/                  # Utilities
โ”‚   โ”œโ”€โ”€ theme.py           # Modern dark theme
โ”‚   โ””โ”€โ”€ constants.py
โ””โ”€โ”€ build/                 # Generated executables

๐Ÿค Contributing

Contributions are welcome! Feel free to:

  • Report bugs or suggest features via Issues
  • Submit Pull Requests with improvements
  • Share feedback on the user experience

๐Ÿ“„ License

This project is open source and available under the MIT License.

ibrahimahtsham/ascii-file-structure-maker-and-lines-of-code-reader | GitHunt