diff --git a/README.md b/README.md index 61f9749..e77f8e3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,387 @@ -# DevPulse โก +
+Understand Your Codebase Instantly โก
+DevPulse analyzes repositories, detects patterns, and helps developers improve productivity.
+
+
+
+
+
+
+
+
+
+
++ +DevPulse is a developer productivity tool designed to analyze source code repositories and provide insights about code structure, quality, and project activity. + +
+ ++Goal: Help developers understand their codebase faster. ++ +
DevPulse scans projects and produces:
+ +Built for:
+ +pip install devpulse-tool ++ +
+devpulse scan . ++ +
+Scanning project... + +Files scanned: 82 + +Languages detected +- Python: 76% +- Markdown: 15% +- JSON: 9% + +TODO items: 12 +Code health score: 8.1 / 10 ++ +
+devpulse scan . ++ +
+devpulse analyze . ++ +
+devpulse dashboard ++ +
+devpulse ai-commit ++ +
DevPulse scans project files to detect:
+ +Automatically detects developer notes:
+ ++# TODO +# FIXME +# HACK ++ +
Useful for tracking unfinished work.
+ +Future AI features include:
+ ++devpulse/ +โ +โโโ cli.py +โ CLI entry point +โ +โโโ scanner.py +โ repository scanning engine +โ +โโโ analyzer.py +โ code analysis engine +โ +โโโ dashboard.py +โ developer statistics +โ +โโโ ai_commit.py +โ AI commit message generator +โ +โโโ utils.py + helper utilities ++ +
| Module | +Purpose | +
|---|---|
| scanner | +scans files and directories | +
| analyzer | +calculates project metrics | +
| dashboard | +visualizes repository stats | +
| ai_commit | +generates commit messages | +
| utils | +shared helper logic | +
+Project: devpulse + +Files scanned: 56 + +Languages +Python: 88% +Markdown: 12% + +TODO items: 7 +FIXME items: 2 + +Code Quality Score: 8.3 / 10 ++ +
DevPulse supports future plugins.
+ ++devpulse/plugins/ + +security_scanner.py +performance_analyzer.py +dependency_audit.py +documentation_generator.py ++ +
Plugins will hook into the analysis pipeline.
+ ++pytest ++ +
Coverage includes:
+ ++git clone https://github.com/manucian-official/devpulse.git ++ +
+cd devpulse ++ +
+pip install -e . ++ +
+devpulse scan . ++ +
DevPulse aims to become a Developer Intelligence Platform.
+ +Long-term goal:
+ ++Transform raw source code into actionable developer insights. ++ +
MIT License
+ +If DevPulse helps you analyze code faster, consider giving the project a star.
+ +