A powerful Python library for mining and analyzing Git repositories

license last-commit repo-top-language repo-language-count PyPI Downloads

• 📍 Overview
• 👾 Features
• 📁 Project Structure
  • 📂 Project Index
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
  • 🤖 Usage
  • 🧪 Testing
• 📌 Project Roadmap
• 🔰 Contributing
• 🎗 License
• 🙌 Acknowledgments

GitAnalyzer is a Python library for mining and analyzing Git repositories. It provides a powerful interface for extracting detailed information about commits, developers, and code changes. The tool supports both local and remote repositories, with features including:

• Commit history traversal and filtering
• Code change analysis
• Developer contribution tracking
• Process metrics calculation
• Support for multiple repository analysis

• Flexible Repository Access: Analyze both local and remote Git repositories
• Comprehensive Commit Analysis: Extract detailed information about commits, including:
  • Author and committer details
  • Modified files and their changes
  • Code churn metrics
  • Commit relationships
• Developer Analytics: Track developer contributions and experience
• Process Metrics: Calculate various software process metrics
• Multiple Repository Support: Analyze multiple repositories in sequence
• Mailmap Support: Proper handling of author mappings via .mailmap files
• Configurable Filters: Filter commits by:
  • Date ranges
  • Commit hashes
  • Tags
  • File types
  • Authors

└── GitAnalyzer/
 ├── LICENSE
 ├── Makefile # Build automation configuration
 ├── dev-requirements.txt # Development dependencies
 ├── docs # Documentation directory
 │ ├── Makefile # Documentation build configuration
 │ ├── commit.rst # Commit analysis documentation
 │ ├── conf.py # Sphinx configuration
 │ ├── deltamaintainability.rst # Maintainability metrics docs
 │ ├── git.rst # Git interface documentation
 │ ├── index.rst # Documentation index
 │ ├── intro.rst # Introduction guide
 │ ├── modifiedfile.rst # File modification docs
 │ ├── processmetrics.rst # Process metrics documentation
 │ ├── reference.rst # API reference
 │ ├── repository.rst # Repository handling docs
 │ ├── requirements.txt # Documentation dependencies
 │ └── tutorial.rst # Usage tutorial
 ├── gitanalyzer # Main package directory
 │ ├── domain # Core domain models
 │ ├── git.py # Git interface implementation
 │ ├── metrics # Analysis metrics implementations
 │ ├── repository.py # Repository management
 │ └── utils # Utility functions and helpers
 ├── pytest.ini # PyTest configuration
 ├── requirements.txt # Core dependencies
 ├── setup.py # Package installation setup
 ├── test-requirements.txt # Testing dependencies
 └── tests # Test suite directory
 ├── integration # Integration tests
 ├── metrics # Metrics tests
 ├── test_*.py # Unit test files

Before getting started with GitAnalyzer, ensure your runtime environment meets the following requirements:

• Python: Version 3.8 or higher
• Git: Any recent version
• Operating System: Linux, macOS, or Windows
• Package Manager: pip

Install GitAnalyzer using one of the following methods:

Build from source:

1. Clone the GitAnalyzer repository:

❯ git clone https://github.com/codingwithshawnyt/GitAnalyzer

2. Navigate to the project directory:

❯ cd GitAnalyzer

3. Install the project dependencies:

Using pip

❯ pip install -r requirements.txt -r dev-requirements.txt -r test-requirements.txt

Here's a basic example of using GitAnalyzer:

from GitAnalyzer import Repository
# Initialize repository (local or remote)
repo = Repository('path/to/repository')
# Traverse commits
for commit in repo.traverse_commits():
 print(f'Commit: {commit.hash}')
 print(f'Author: {commit.author.name}')
 print(f'Date: {commit.author_date}')
 
 # Access modified files
 for modification in commit.modified_files:
 print(f'Modified file: {modification.filename}')
 print(f'Changes: +{modification.added_lines}, -{modification.deleted_lines}')

Run the test suite using the following command:

❯ pytest

For coverage report:

❯ pytest --cov=gitanalyzer

• Core Functionality: Basic commit traversal and analysis
• Process Metrics: Implementation of various process metrics
• Multiple Repository Support: Ability to analyze multiple repositories
• Documentation: Comprehensive documentation with Sphinx
• Additional Metrics: Implementation of more advanced metrics
• Performance Optimization: Improve analysis speed for large repositories

• 💬 Join the Discussions : Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues : Submit bugs found or log feature requests for the GitAnalyzer project.
• 💡 Submit Pull Requests : Review open PRs, and submit your own PRs.

This project is protected under the Apache License 2.0 License. For more details, refer to the LICENSE file.

• GitPython: Core Git interaction functionality
• Sphinx: Documentation generation
• pytest: Testing framework
• All contributors who have helped improve GitAnalyzer