Skip to main content

CLI to check status of git repositories

Project description

Git Repo Checker

PyPI - Version

CLI to get status of git repositories.

Installation

Pip

To install using pip simply run the command below:

pip install gitrepochecker

Nix/NixOS

Repo checker can be installed using Nix Flakes, see the section below.

Nix Flakes

Add the required inputs to your flake configuration:

flake.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

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

Usage

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitrepochecker-0.3.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitrepochecker-0.3.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file gitrepochecker-0.3.0.tar.gz.

File metadata

  • Download URL: gitrepochecker-0.3.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gitrepochecker-0.3.0.tar.gz
Algorithm Hash digest
SHA256 df58e43472d992af27139bf3435823faa7b28da89ecfe2b0d6c25d2f07aaa884
MD5 7114c3dd50424ce29059ac0ff459bd0a
BLAKE2b-256 2aa26f5122a9eff7af630cab5bf48bb8a91f9ad5a1483768257e57e2b71d9f40

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitrepochecker-0.3.0.tar.gz:

Publisher: python-publish.yml on olillin/repochecker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gitrepochecker-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: gitrepochecker-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gitrepochecker-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51b280b577c1ff54441e6fceda2462b0b4dd8b86ef0ac9c02279d64f589c4148
MD5 1374597539c0ec4c28c98072e0745228
BLAKE2b-256 b6230308889eaa33932c1f221eac0645a874ba450cb5fd027a4211ca5995144f

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitrepochecker-0.3.0-py3-none-any.whl:

Publisher: python-publish.yml on olillin/repochecker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page