GitInspectorGUI Developer Documentation

Development environment and tooling documentation for GitInspectorGUI contributors.

Note: For application usage and features, see the User Documentation tab in the navigation bar above, or visit gitinspectorgui.readthedocs.io.

Quick Navigation

Try the Demo

• Interactive Demo - Try GitInspectorGUI in your browser without installation

New to the Project?

• Technology Primer - Understanding the development tools
• Prerequisites - System requirements and tool installation
• Installation Guide - Detailed setup
• Quick Start - Get running in 3 steps

Development

• Development Workflow - Core development patterns
• Package Management - Dependencies and tools
• Build Process - Creating releases
• Publishing Guide - Package publishing to PyPI
• Environment Setup - Development configuration
• Troubleshooting - Common issues

Command Line Interface

• CLI Development Guide - Building and testing CLI

API Development

• PyO3 API Reference - Complete API documentation
• API Examples - Usage patterns and code samples
• Error Handling - Error codes and troubleshooting

Architecture & Operations

• System Overview - System architecture
• Technology Stack - Technology choices
• PyO3 Integration Architecture - Architectural rationale
• Release & Distribution - Production deployment
• Server Management - Operational procedures

Features

• PyO3 Helper Function Architecture - Tauri desktop frontend with embedded Python backend
• Cross-Platform - Windows, macOS, Linux support
• Git Analysis - Comprehensive repository insights
• Interactive UI - React-based interface with filtering
• Developer API - Complete PyO3 API documentation

Architecture

graph TD
    A[Tauri Frontend] --> B[PyO3 Helper Functions]
    B --> C[Embedded Python Engine]
    C --> D[Git Analysis Engine]
    D --> E[Repository Data]

    F[Settings] --> A
    G[Results Store] --> A
    H[API Types] --> B