talkmycode 0.1.0

A Python library that analyzes code complexity and provides human-friendly explanations.

TalkMyCode

A Python library that analyzes code complexity and provides human-friendly explanations, like a coding mentor.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/talkmycode.git
   cd talkmycode
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Install the package:

   pip install -e .
   

Usage

Analyze a Python file:

analyze-code path/to/your/file.py

Options:

• --mode: Choose explanation mode (friendly, strict, mentor). Default: friendly
• --speak: Enable text-to-speech for explanations

Example:

analyze-code example.py --mode mentor --speak

Example Output

Overall Complexity Score: 15
Readability Score: 85.50
Halstead Volume: 120.50
Halstead Difficulty: 5.20
Halstead Effort: 626.60

Issues:
- Function 'long_func' is too long (25 lines). Consider breaking it into smaller functions.

Suggestions:
- Break 'long_func' into smaller, focused functions.

Explanations:
- Hey! Your function 'long_func' is quite long. Long functions can be hard to understand. Try splitting it into smaller pieces!

Features

• AST-based code analysis
• Cyclomatic complexity calculation
• Detection of long functions, deep nesting, nested ifs
• Human-friendly explanations in different modes
• Actionable suggestions for improvements
• Text-to-speech support
• CLI interface

Contributing

Feel free to contribute by opening issues or pull requests.

License

MIT License