diff --git a/README.md b/README.md index 61f9749..e77f8e3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,387 @@ -# DevPulse โšก +
-Analyze your entire codebase in seconds. + -Features -- Language statistics -- TODO / FIXME detection -- Largest file detection -- Project health score +

DevPulse

-Install +

+AI-Powered Code Intelligence CLI +

+ +

+Understand Your Codebase Instantly โšก
+DevPulse analyzes repositories, detects patterns, and helps developers improve productivity. +

+ +

+ + + + + + + +

+ + + +
+ +
+ +

๐Ÿง  What is DevPulse?

+ +

+ +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:

+ + + +
+ +

๐Ÿš€ Quick Start

+ +

Install from PyPI

+ +
 pip install devpulse-tool
+
+ +

Scan a project

+ +
+devpulse scan .
+
+ +

Example Output

+ +
+Scanning project...
+
+Files scanned: 82
+
+Languages detected
+- Python: 76%
+- Markdown: 15%
+- JSON: 9%
+
+TODO items: 12
+Code health score: 8.1 / 10
+
+ +
+ +

โšก CLI Commands

+ +

Scan repository

+ +
+devpulse scan .
+
+ +

Analyze code quality

+ +
+devpulse analyze .
+
+ +

Developer productivity metrics

+ +
+devpulse dashboard
+
+ +

Generate AI commit message

+ +
+devpulse ai-commit
+
+ +
+ +

โœจ Features

+ +

๐Ÿ“Š Repository Analysis

+ +

DevPulse scans project files to detect:

+ + + +

๐Ÿงพ TODO & FIXME Detection

+ +

Automatically detects developer notes:

+ +
+# TODO
+# FIXME
+# HACK
+
+ +

Useful for tracking unfinished work.

+ +

๐Ÿ“ˆ Code Quality Insights

+ + + +

๐Ÿค– AI Developer Tools

+ +

Future AI features include:

+ + + +
+ +

๐Ÿ— Architecture

+ +
+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
+
+ +

Core Modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModulePurpose
scannerscans files and directories
analyzercalculates project metrics
dashboardvisualizes repository stats
ai_commitgenerates commit messages
utilsshared helper logic
+ +
+ +

โš™๏ธ How DevPulse Works

+ +

1๏ธโƒฃ Repository Scanning

+ + + +

2๏ธโƒฃ Code Analysis

+ + + +

3๏ธโƒฃ Insight Generation

+ + + +
+ +

๐Ÿ“Š Example Output

+ +
+Project: devpulse
+
+Files scanned: 56
+
+Languages
+Python: 88%
+Markdown: 12%
+
+TODO items: 7
+FIXME items: 2
+
+Code Quality Score: 8.3 / 10
+
+ +
+ +

๐Ÿงฉ Plugin Architecture

+ +

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.

+ +
+ +

๐Ÿงช Testing

+ +
+pytest
+
+ +

Coverage includes:

+ + + +
+ +

๐Ÿ“ฆ Development Setup

+ +

Clone repository

+ +
+git clone https://github.com/manucian-official/devpulse.git
+
+ +

Enter directory

+ +
+cd devpulse
+
+ +

Install dev mode

+ +
+pip install -e .
+
+ +

Run CLI

+ +
+devpulse scan .
+
+ +
+ +

๐Ÿงญ DevPulse Vision

+ +

DevPulse aims to become a Developer Intelligence Platform.

+ + + +

Long-term goal:

+ +
+Transform raw source code into actionable developer insights. +
+ +
+ +

๐Ÿค Contributing

+ +
    +
  1. Fork the repository
  2. +
  3. Create a new branch
  4. +
  5. Implement your feature
  6. +
  7. Submit a pull request
  8. +
+ +
+ +

๐Ÿ“„ License

+ +

MIT License

+ +
+ +
+ +

โญ Support the Project

+ +

If DevPulse helps you analyze code faster, consider giving the project a star.

+ +

DevPulse

+ +Code Intelligence for Developers -Usage -devpulse my_project +