Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

CLI tool in Python to recursively scan a directory, read every file (with error handling), and generate a single Markdown-formatted summary file. Supports path normalization, progress logging, and customizable output filenames—ideal for quick code overviews or project documentation.

License

Notifications You must be signed in to change notification settings

Eng-M-Abdrabbou/Python-Recursive-Directory-CodeSummary-Tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

3 Commits

Repository files navigation

Code Base Summary CLI

Python Version License: MIT

A lightweight Python CLI tool to recursively scan a directory, read every file (with robust error handling), and produce a single Markdown-formatted summary file. Ideal for quick code overviews, documentation snapshots, or audits.

Table of Contents

Features

  • Recursively traverses directories (skips .git, __pycache__, etc.)
  • Normalizes and logs relative file paths
  • Reads files using UTF-8 (ignores binary/non-standard errors)
  • Wraps content in Markdown code blocks
  • Shows progress and handles I/O exceptions
  • Customizable output filename

Installation

git clone [https://github.com/Eng-M-Abdrabbou/Python-Recursive-Directory-CodeSummary-Tool.git](https://github.com/Eng-M-Abdrabbou/Python-Recursive-Directory-CodeSummary-Tool.git)
cd CodeBaseSummary-CLI-Python-Script
# No external dependencies; uses Python stdlib

Usage

in the terminal run this command: python CS.py <root_dir> [output_filename]

##Examples

** generate code_summary.txt in current folder ** python CS.py ./my_project

** custom output name ** python CS.py ~/workspace/my_project docs/project_code.md

Contributing

Fork the repo Create a feature branch (git checkout -b feature/xyz) Commit your changes (git commit -m "Add xyz") Push to your branch (git push origin feature/xyz) Open a Pull Request Please follow the existing code style and add tests where applicable.

License

This project is licensed under the MIT License. See the LICENSE file for details."

About

CLI tool in Python to recursively scan a directory, read every file (with error handling), and generate a single Markdown-formatted summary file. Supports path normalization, progress logging, and customizable output filenames—ideal for quick code overviews or project documentation.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

AltStyle によって変換されたページ (->オリジナル) /