Metadata-Version: 2.3
Name: gitrepochecker
Version: 0.3.0
Summary: CLI to check status of git repositories
Author: Oli
Author-email: Oli <oli@olillin.com>
License: MIT License
         
         Copyright (c) 2026 Olillin
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Dist: colorama>=0.4.6
Maintainer: Oli
Maintainer-email: Oli <oli@olillin.com>
Requires-Python: >=3.13
Project-URL: Bug Reports, https://github.com/olillin/repochecker/issues
Project-URL: Source, https://github.com/olillin/repochecker
Description-Content-Type: text/markdown

# Git Repo Checker

[![PyPI - Version](https://img.shields.io/pypi/v/gitrepochecker?style=flat-square&logo=Python&logoColor=white)](https://pypi.org/project/gitrepochecker)

CLI to get status of git repositories.

## Installation

### Pip

To install using **pip** simply run the command below:

```console
pip install gitrepochecker
```

### Nix/NixOS

Repo checker can be installed using [Nix Flakes](#nix-flakes), see the section below.

#### Nix Flakes

Add the required inputs to your flake configuration:

`flake.nix`

```nix
{
  description = "NixOS configuration with gitrepochecker";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-25.11";

    repochecker = {
      url = "github:olillin/repochecker";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs = {
    self,
    nixpkgs,
    ...
  } @ inputs: {
    nixosConfigurations.yourconfiguration = nixpkgs.lib.nixosSystem {
      specialArgs = {inherit inputs;};
      modules = [
        ./configuration.nix
      ];
    };
  };
}
```

Install the package in your `configuration.nix` or an imported module:

`configuration.nix`

```nix
{
  pkgs,
  inputs,
  ...
}: {
  environment.systemPackages = with pkgs; [
    inputs.repochecker.packages.${pkgs.stdenv.hostPlatform.system}.default
  ];
}
```


## Usage

```console
usage: repochecker [-h] [-i | -a] [-s | -r] [-d RECURSION_DEPTH] [-b] directory

Check git repository information and get a summary

positional arguments:
  directory

options:
  -h, --help            show this help message and exit
  -i, --invert
  -a, --all
  -s, --single
  -r, --recursive
  -d RECURSION_DEPTH, --recursion-depth RECURSION_DEPTH
  -b, --brief
```

## Example response

```console
C:\Users\oli\Workspaces>repochecker .

C:\Users\oli\Workspaces\Blockstates
 Is git repo: False


C:\Users\oli\Workspaces\RepoChecker
 Is git repo: True
 Current branch: None
 Branches: 
  * main -> origin/main
 No uncommited changes: False
 No unpushed commits: True
 No stashed changes: True


C:\Users\oli\Workspaces\XaeroMerge
 Is git repo: True
 Current branch: None
 Branches: 
  * main -> origin/main ahead 1
 No uncommited changes: False
 No unpushed commits: False
 No stashed changes: True
```
