Skip to content

About

Generate a read-only HTML report showing folder sizes, top-level breakdowns, and the largest files.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Folder Footprint banner Animated project title

Generate a read-only HTML report showing folder sizes, top-level breakdowns, and the largest files.

MIT license Top language Stars Last commit

Folder size report illustration

🎯 Overview

Folder Footprint scans a directory and creates a portable HTML report with total size, top-level folder sizes, and the largest files. It is read-only: it skips symlinks and common generated folders, and never deletes or changes source files.

✨ Features

  • 📁 Summarizes sizes of top-level folders and files.
  • 📦 Lists the largest files in the scanned tree.
  • 📊 Generates a clean, responsive HTML report with relative-size bars.
  • 🛡️ Skips symlinks and common generated directories.
  • 🔒 Performs no cleanup or destructive actions.

🎬 Demo

python main.py ~/Downloads --output downloads-report.html

Open the generated HTML file in your browser.

🚀 Quick Start

python main.py ./your-folder --output folder-footprint.html

🧰 Tech Stack

  • Python 3.10+ standard library
  • pathlib, os.scandir, and HTML escaping

🗂️ Folder Structure

folder-footprint/
├── main.py
├── requirements.txt
└── assets/
    └── illustration.svg

🧭 Roadmap

  • Add an optional JSON report format.
  • Add configurable directory exclusions.
  • Add a treemap visualization for nested folders.

🤝 Contributing

Issues and pull requests are welcome. Include your operating system, a small directory example, and the command used when reporting a bug.

📄 License

Released under the MIT License. See LICENSE.

Animated wave footer

About

Generate a read-only HTML report showing folder sizes, top-level breakdowns, and the largest files.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages