Metadata-Version: 2.4
Name: auto-commenter
Version: 0.1.0
Summary: A Python package for automatically generating docstrings based on function arguments and return types.
Home-page: https://github.com/Dinesh123527/auto-commenter
Author: veganapa
Author-email: varmadinesh249@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: pandas
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Auto Commenter

Auto Commenter is a Python package that automatically generates docstrings for your Python functions and classes based on their arguments and return types. It uses **abstract syntax tree (AST)** analysis to inspect the code and generate informative comments.

## Features

- Automatically generates docstrings for functions and classes.
- Infers argument types based on common patterns (e.g., `num`, `data`, `arr`).
- Supports return type detection, including for `int`, `str`, `list`, `dict`, `pd.DataFrame`, and `np.ndarray`.
- Easily integrate into your workflow to improve code documentation.

## Installation

You can install Auto Commenter from **PyPI** using pip:

```bash
pip install auto-commenter
