Skip to content

A modular and efficient Python tool to analyze, search, and export details about file system contents. Built for developers, students, and system admins who want a better understanding of their directory structure and file usage.

Notifications You must be signed in to change notification settings

Ay-developerweb/file_system_analyzer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ—‚οΈ File System Analyzer

A modular and efficient Python tool to analyze, search, and export details about file system contents. Built for developers, students, and system admins who want a better understanding of their directory structure and file usage.


πŸš€ Features

  • πŸ“ Recursively scans directories
  • πŸ“Š Calculates file system statistics
  • πŸ” Supports file searching by name or extension
  • πŸ“€ Exports data in JSON format
  • 🧱 Modular code structure for easy maintenance

πŸ“ Project Structure

file_system_analyzer/
β”œβ”€β”€ main.py              # Entry point for CLI usage
β”œβ”€β”€ _main.py             # Alternative or test entry
└── analyzer/
    β”œβ”€β”€ traversal.py     # Handles directory traversal
    β”œβ”€β”€ statistics.py    # Gathers file system stats
    β”œβ”€β”€ search.py        # Provides search capabilities
    β”œβ”€β”€ json_export.py   # Handles exporting results
    β”œβ”€β”€ utils.py         # Utility functions

πŸ› οΈ Installation

  1. Clone the repo
git clone https://github.com/Ay-developerweb/file-system-analyzer.git
cd file-system-analyzer
  1. (Optional) Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate
  1. Install dependencies
pip install -r requirements.txt

If no requirements.txt exists, the project likely uses only standard libraries.


▢️ Usage

Run the analyzer:

python main.py [target_directory]

If no directory is passed, it defaults to the current working directory.


πŸ“€ JSON Export

The tool supports exporting results to a .json file:

python main.py /path/to/dir --export report.json

🀝 Contribution

Feel free to fork this repo and submit pull requests. Ideas and improvements are always welcome!


πŸ“„ License

This project is licensed under the MIT License.


πŸ‘€ Author

Adediran Ayomide Mathew
πŸ“§ ayomideadediran45@gmail.com 🌐 GitHub Profile

About

A modular and efficient Python tool to analyze, search, and export details about file system contents. Built for developers, students, and system admins who want a better understanding of their directory structure and file usage.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages