pyfilemetre 0.1.6

pyfilemetre is a Python CLI tool that analyzes code using AST — counting functions, classes, and missing docstrings, and generating Markdown reports.

pyfilemetre: Python Codebase Analyzer

pyfilemetre is a Python CLI tool that counts classes and functions, checks for docstrings, and generates Markdown reports for Python projects. It is designed to give you a clear, file-by-file summary of your codebase quickly.

---

Features

• Counts classes and functions.
• Checks for missing docstrings.
• Generates Markdown reports summarizing the project.
• Interactive CLI with spinner animation.
• Optional flag to skip saving the report.

---

Installation

You can install pyfilemetre from PyPI:

pip install pyfilemetre

Note: Currently not available for local development!

---

Usage

Run pyfilemetre on a Python file or directory:

python -m pyfilemetre <path_to_project>

Example:

python -m pyfilemetre "C:\Users\You\Desktop\demo_project"

Saving the report.md file:

<path_to_project\report.md>

Example:

C:\Users\You\Desktop\demo_project\report.md

Note:

• Do not put the file path in double quotes ("") when entering as path to save report.md file.
• Always specify \report.md at the end of the path you give.

---

Execution Flow

---

1. You'll see a spinner animation showing progress.
2. The terminal will display a summary of classes, functions, and docstrings.
3. You’ll be prompted to save a Markdown report. Enter y to save and provide a path, or n to skip.

Optional Flags

• --no-md = Skip saving the Markdown report.

Example with flag:

python -m pyfilemetre "C:\Users\You\Desktop\demo_project" --no-md

---

Complete execution flow

Installation of pyfilemetre:

Information about pyfilemetre:

Using pyfilemetre to get the summary of your codebase without saving the file:

Gives same result if you use --no-md:

Generating summary and saving the report (notice how i didn't enclose the path with ""):

The report:

---

License

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

---

Notes

• Python 3.8+ required.
• Works on Windows, macOS, and Linux.
• Tabulate library is used for nice terminal output.

---

Created by Aditi Gupta.