Metadata-Version: 2.4
Name: git-overview
Version: 0.1
Summary: Quick and pretty overview of many git local repositories at once compared to their remotes
Author-email: David Bellot <david.bellot@gmail.com>
Maintainer-email: David Bellot <david.bellot@gmail.com>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/yimyom/git-overview
Project-URL: Documentation, https://github.com/yimyom/git-overview
Project-URL: Repository, https://github.com/yimyom/git-overview
Project-URL: Changelog, https://github.com/yimyom/git-overview/blob/master/Changelog
Project-URL: Issues, https://github.com/yimyom/git-overview/issues
Keywords: git
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Git Overview

A powerful command-line tool to quickly scan directories and display the status of all Git repositories. Get an overview of which repositories are ahead/behind their remotes across your entire projects folder.

<img width="522" height="432" alt="image" src="https://github.com/user-attachments/assets/e4cee351-5ee8-4ae8-97f3-621c487af6d8" />

## Features

- 🔍 **Recursive scanning** - Automatically finds all Git repositories in a directory tree
- 📊 **Multi-branch support** - Check status for current branch plus main/master or custom branches
- 🎨 **Beautiful output** - Colorful, formatted tables with Unicode box-drawing characters
- 💾 **Multiple formats** - Pretty, simple, and CSV output formats
- ⚡ **Parallel processing** - Fast scanning using multiple threads
- 📁 **Exclusion support** - Skip specific directories from scanning

## Installation

### Install from PyPI
```bash
pip install git-overview
```

### Manual Installation
```bash
# Download the script and make it executable
wget https://raw.githubusercontent.com/yourusername/git-overview/main/git-overview.py
chmod +x git-overview.py
sudo mv git-overview.py /usr/local/bin/git-overview
```

### Install as DEB Package (Ubuntu/Debian)
```bash
wget https://github.com/yourusername/git-overview/releases/latest/download/git-overview_all.deb
sudo dpkg -i git-overview_all.deb
```

## Usage
It can be invoked
```bash
# Scan current directory
git overview

# Scan specific directory
git overview ~/projects

# Include main/master branches
git overview --main

# Check specific additional branches
git overview --branch develop,feature/new-feature

# Exclude directories
git overview --exclude node_modules,dist,build

# Simple output (no colors/Unicode)
git overview --format simple

# CSV output
git overview --format csv

# Sort by ahead/behind count
git overview --sort ahead
```

## Requirements
 - Python 3.6+
 - Git

## License
GPL-3.0 License - See LICENSE file for details.
